设置访问鉴权
更新时间：2023-04-04
接口
本接口用于设置域名的访问鉴权。
| Method | Path | 说明 |
|---|---|---|
| PUT | /v2/domain/{domain}/config?requestAuth | 配置访问鉴权 |
domain：修改配置的CDN加速域名。
请求体（Request Body）
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| requestAuth | 必选 | requestAuth | 访问鉴权配置 |
requestAuth类型
| 参数 | 可选 | 类型 | 说明 |
|---|---|---|---|
| type | 必选 | String | A/B/C 三种鉴权方式 |
| key1 | 必选 | String | 主鉴权key,输入大小写字母，数字，长度6到32位 |
| key2 | 可选 | String | 副鉴权Key，输入大小写字母，数字，长度6到32位 |
| timeout | 可选 | Int | 鉴权有效时间，A/B/C三类鉴权方式都支持，单位为秒；URL鉴权的过期时间为指定“timestamp+timeout”；默认为1800。UTC时间 |
| whiteList | 可选 | List | 白名单列表，在该名单中的文件名不需要鉴权 |
| signArg | 可选 | String | 签名参数名，只对type C生效 |
| timeArg | 可选 | String | 时间戳参数名，只对type C生效 |
| timestampFormat | 可选 | string | 鉴权时间格式。可选值为"dec"、"hex"、"yyyyMMDDhhmm"，分别表示10进制时间格式，16进制时间格式、字符串类的时间格式。其中，只有type为B时才可以取值"yyyyMMDDhhmm" |
| 可选 | string | 时间格式。值为10，16或者yyyyMMDDhhmm，分别表示10进制时间格式，16进制时间格式以及字符串类的时间格式。其中yyyyMMDDhhmm只有type为B的时候可以为该值 |
注：当request body为 {"requestAuth":[]}时表关闭鉴权功能。case见请求示例4
响应码 (Http Status Code)
| HTTP Status Code | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 更新失败，参数错误等 |
请求示例1：设置C类防盗链
PUT /v2/domain/test.baidu.com/config?requestAuth HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8
{
"requestAuth": {
"type": "C",
"key1": "secretekey1",
"key2": "secretekey2",
"timeout": 300,
"whiteList": ["/crossdomain.xml"],
"signArg":"sign",
"timeArg":"t",
"timestampFormat":"dec"
}
}请求示例2：设置B类防盗链
PUT /v2/domain/test.baidu.com/config?requestAuth HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8
{
"requestAuth": {
"type": "B",
"key1": "secretekey1",
"key2": "secretekey2",
"delAuthKey": true,
"timeout": 1800,
"timestampFormat": "yyyyMMDDhhmm"
}
}请求示例3：设置A类防盗链
PUT /v2/domain/test.baidu.com/config?requestAuth HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8
{
"requestAuth": {
"type": "A",
"key1": "secretekey1",
"key2": "secretekey2",
"delAuthKey": true,
"timeout": 1800,
"timestampFormat": "hex"
}
}请求示例4：关闭防盗链
PUT /v2/domain/myself.baidu.com/config?requestAuth HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 18
Content-Type: text/json;utf-8
{"requestAuth":null}响应示例
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 26 Jun 2019 05:57:29 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.1.5
x-bce-request-id: 8a9c4d38-5198-ed4e-b279-272fdde46e4b
{"status":"RUNNING"}