接口功能介绍
用户可在点播模式下通过本接口向云点播的存储桶配置Referer防盗链。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
URI
POST /accessControl/referer/set
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionCode | 否 | String | 可选参数,资源池编码。如不传入则设置默认资源池的acl。 | xs-cn-guangzhou-1 | |
enable | 是 | Boolean | 是否启用:true-启用;false-禁用。(1)true:表示设置防盗链,下面的字段均为必填;(2)false:表示删除防盗链,下面的字段均不用填。 | true | |
type | 否 | String | 类型,包含 WHITE-LIST/BLACK-LIST。 | BLACK-LIST | |
allowEmpty | 否 | Boolean | 是否允许为空 | false | |
referers | 否 | Array of Strings | 设置的名单 | ["http://www.ctyun.cn","http://*.ctyunapi.com"] |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | Integer | 本次请求的结果码 | 0 | |
message | 是 | String | 错误文本信息,创建成功时,为空字符串。 | "" |
请求示例
请求体body
{
"regionCode": "xs-cn-guangzhou-1",
"enable": true,
"type": "BLACK-LIST",
"allowEmpty": false,
"referers": [
"http://www.ctyun.cn",
"http://*.ctyunapi.com"
]
}
响应示例
{
"code": 0,
"message": ""
}
状态码
Http 状态码 | 状态码信息 | 状态码描述 |
---|---|---|
0 | 表示业务成功 | 表示业务成功 |
400 | 请求参数有误 | 请求参数有误 |
403 | 用户鉴权失败,用户无操作权限 | 用户鉴权失败,用户无操作权限 |
404 | 请求的资源不存在,输入错误的URL | 请求的资源不存在,输入错误的URL |
500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。