取得開通點播實例列表
更新時間 2025-05-08 09:29:24
最近更新時間: 2025-05-08 09:29:24
分享文章
通過本接口向云點播查詢點播實例列表。
接口功能介紹
用戶可通過本接口向云點播查詢已經創建的點播實例列表。
注意：自2025年5月7日零時起，云點播對資源分配方式進行了升級，原【點播區域】更名為【點播實例】。新開通客戶將以實例化方式提供媒資存儲、媒體處理等服務，不再以資源池方式進行命名和資源劃分。接口中regionCode參數會繼續沿用一段時間。
接口約束
本接口的單用戶QPS限制為20次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
URI
POST /management/region/list
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionCode | 否 | String | 可選參數，點播實例編碼，傳入了該參數之后，僅返回在此指定的點播實例信息。 | xs-cn-guangzhou-1 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次請求的結果碼 | 0 | |
| message | 是 | String | 錯誤文本信息，創建成功時，為空字符串。 | "" | |
| data | 是 | Array of Objects | 返回數據 | data |
表 data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| region | 是 | Object | 區域 | gz000001 | region |
| isDefault | 是 | Boolean | 是否為默認實例 | true | |
| buckets | 是 | Object | 相關的存儲桶信息 | buckets | |
| acl | 是 | String | 讀寫權限，包含 PRIVATE/PUBLIC-READ/PUBLIC-READ-WRITE。 | PUBLIC-READ | |
| referer | 是 | Object | Referer防盜鏈信息 | referer |
表 region
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 區域名 | 華南1 | |
| code | 是 | String | 區域編碼 | xs-cn-guangzhou-1 |
表 buckets
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| origin | 是 | String | 原視頻桶名 | vod-origin-c7a5 | |
| transcode | 是 | String | 轉碼桶名稱 | vod-transcode-c7a5 |
表 referer
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| enable | 是 | Boolean | 是否啟用：true-啟用;false-禁用（為false時表示一條policy都沒有，所以下面的字段都將為空）。 | true | |
| type | 否 | String | 類型，包含 WHITE-LIST/BLACK-LIST。 | WHITE-LIST | |
| allowEmpty | 否 | Boolean | 是否允許為空 | false | |
| referers | 否 | Array of Strings | 設置的名單 | ["//www.daliqc.cn","//*.ctcdn.cn"] |
請求示例
請求體body
{
"regionCode": "xs-cn-guangzhou-1"
}
響應示例
{
"code": "0",
"message": "",
"data": [
{
"region": {
"name": "華南1",
"code": "xs-cn-guangzhou-1"
},
"isDefault": true,
"buckets": {
"origin": "vod-origin-c7a55f8e-e178-4dcb-b813-7c2801c58ee5",
"transcode": "vod-transcode-c7a55f8e-e178-4dcb-b813-7c2801c58ee5",
},
"acl": "PUBLIC-READ",
"referer": {
"enable": true,
"type": "WHITE-LIST",
"allowEmpty": false,
"referers": [
"//www.daliqc.cn",
"//*.ctcdn.cn"
]
}
}, {
"region": {
"name": "華中1",
"code": "xs-cn-shanghai-1"
},
"isDefault": false,
"buckets": {
"origin": "vod-origin-c7a55f8e-e178-4dcb-b813-7c2801c58ee6",
"transcoaclde": "vod-transcode-c7a55f8e-e178-4dcb-b813-7c2801c58ee6",
},
"acl": "PUBLIC-READ",
"referer": {
"enable": true,
"type": "BLACK-LIST",
"allowEmpty": false,
"referers": [
"//www.daliqc.cn",
"//*.ctcdn.cn"
]
}
}
]
}
狀態碼
| Http 狀態碼 | 狀態碼信息 | 狀態碼描述 |
|---|---|---|
| 0 | 表示業務成功 | 表示業務成功 |
| 400 | 請求參數有誤 | 請求參數有誤 |
| 403 | 用戶鑒權失敗，用戶無操作權限 | 用戶鑒權失敗，用戶無操作權限 |
| 404 | 請求的資源不存在，輸入錯誤的URL | 請求的資源不存在，輸入錯誤的URL |
| 500 | 業務執行異常 | 業務執行異常 |
錯誤碼
OpenAPI錯誤碼請參考 錯誤碼說明。
