接口功能介绍
用户可在点播模式下通过本接口向云点播查询已经开通服务的点播区域列表。
接口约束
本接口的单用户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 | 设置的名单 | ["http://www.ctyun.cn","http://*.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": [
"http://www.ctyun.cn",
"http://*.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": [
"http://www.ctyun.cn",
"http://*.ctcdn.cn"
]
}
}
]
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
