全局设置接口

更新时间：2024-08-30

查询CDN域名

按照cdn域名（domain）查询域名

请求语法

GET /v2/domains/{domain} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	path	string	是	要查询的域名

请求示例

GET /v2/domains/egyrfpkuyz52k8jakmb3.vod.e-web.com.cn HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

名称	类型	必选	说明
appId	string	true
description	string	true
enableHttps	boolean	true
createTime	string	true
updateTime	string	true
domain	string	true
cname	string	true
httpsConfig	object	false
enabled	boolean	true	是否启用https
certId	string	false	当enabled=true时此项为必选，为SSL证书服务返回的证书ID，当enablae=false且certId=""时解绑domain当前绑定的certId，否则当enabled=false时此项无效
httpRedirect	boolean	false	为true时将HTTP请求重定向到HTTPS（重定向状态码为httpRedirectCode所配置）。默认为false，当enabled=false时此项无效，不可与httpsRedirect同时为true
httpRedirectCode	int	false	重定向状态码。可选值301/302，默认302，当enabled=false此项无效，httpRedirect=false此项无效
httpsRedirect	boolean	false	为true时将HTTPS请求重定向到HTTP（重定向状态码为httpsRedirectCode所配置）。默认为false，当enabled=false时此项无效，不可与httpRedirect同时为true
httpsRedirectCode	int	false	重定向状态码。可选值301/302，默认302，当enabled=false此项无效，httpsRedirect=false此项无效
noRedirectedUAs	[string]	false	重定向时，排除包含特定UA的请求。数组元素不能超过10个，当enabled=false时此项无效，httpsRedirect、httpsRedirect有且仅有一个为true时，设置的此项有效（noRedirectedUAs=[]表示清空该项的历史值）
http2Enabled	boolean	false	是否开启HTTP2特性。默认true，当enabled=false此项无效
verifyClient	boolean	false	是否开启HTTPS双向认证。默认为false，只有开启了服务端HTTPS认证才可以开启该配置
sslProtocols	[string]	false	设置访问TLS版本。默认为支持从TLSv1.0到TLSv1.3的版本，也可以主动设置为"TLSv1.0"、"TLSv1.1"、"TLSv1.2"、"TLSv1.3"四个中的一个或多个，该参数不能为空list，当enabled=false时此项无效，此项一般取默认值，无需设置
certificate	object	false	SSL证书，当enabled=true时有效
+ certName	string	true
+ certServerData	string	true
+ certPrivateData	string	true
+ certLinkData	string	true
cors	CorsInfo	false
allow	string	true	是否允许跨域
originList	[string]	false	处理跨域时，支持的域名列表。示例参考https://cloud.baidu.com/doc/CDN/s/tjxzi2d7t
refererACL	object	false
allowEmpty	boolean	true
blackList	[string]	false
whiteList	[string]	false
ipACL	object	false
blackList	[string]	false
whiteList	[string]	false
uaACL	object	false
blackList	[string]	false
whiteList	[string]	false
cacheTTL	[CacheTtlInfo]	false
type	string	true	"suffix"表示文件名后缀，"path"表示url中的目录，"code"表示异常码缓存(如可以配置404缓存100s) ，“exactPath”表示路径完全匹配
value	string	true	type所指定类型的配置规则
weight	int	true	权重，0-100的整数，权重越高优先级越高，默认为0，优先级在为code类型下是没有作用的，可以忽略
ttl	int	true	缓存时间，单位为秒
overrideOrigin	boolean	true	存是否遵循源站，默认true。overrideOrigin=true表示不遵循源站，按照该条配置规则缓存

响应示例

GET /v2/domains/egyrfpkuyz52k8jakmb3.vod.e-web.com.cn HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

{
    "appId": "egyrfpkuyz52k8jakmb3",
    "domain": "egyrfpkuyz52k8jakmb3.vod.e-web.com.cn",
    "cname": "egyrfpkuyz52k8jakmb3.vod.e-web.com.cn.a.bdydns.com",
    "cnameValid": false,
    "type": "SYSTEM",
    "status": "RUNNING",
    "description": "系统默认域名",
    "enableHttps": false,
    "createTime": "2024-07-26T03:06:54Z",
    "updateTime": "2024-07-31T13:02:09Z",
    "httpsConfig": {
        "enabled": false,
        "httpRedirect": false,
        "httpsRedirect": false,
        "http2Enabled": true,
        "verifyClient": false,
        "sslProtocols": [
            "TLSv1.0",
            "TLSv1.1",
            "TLSv1.2",
            "TLSv1.3"
        ]
    },
    "cors": {
        "allow": false,
        "originList": []
    },
    "refererACL": {
        "allowEmpty": true
    },
    "ipACL": {},
    "userAgentACL": {
        "whiteList": []
    }
}

删除自定义域名

删除指定的cdn域名

请求语法

DELETE /v2/domains/{domain} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	path	string	否	要删除的域名

请求示例

DELETE /v2/domains/egyrfpkuyz52k8jakmb3.vod.e-web.com.cn HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

无

响应示例

DELETE /v2/domains/egyrfpkuyz52k8jakmb3.vod.e-web.com.cn HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

查询CDN域名列表(分页)

分页查询CDN域名

请求语法

GET /v2/domains?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	query	string	否	模糊搜索域名
pageNo	query	int	否
pageSize	query	int	否
type	query	string	否	取值：SYSTEM, USER
status	query	string	否	域名状态，取值：OPERATING, RUNNING, BAN
enableHttps	query	string	否	是否开启了https，取值：true, false
sortBy	query	string	否	取值：DOMAIN,CREATE_TIME, UPDATE_TIME,ENABLE_HTTPS,STATUS,TYPE。取值前加上减号则代表逆序。多个字段之间用逗号隔开

请求示例

GET /v2/domains?pageNo=1&pageSize=2 HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

名称	类型	必选	说明
data	[object]	true
+ appId	string	true
+ description	string	true	描述
+ status	string	true	状态
+ enableHttps	boolean	true	是否为https
+ createTime	string	true	创建时间
+ updateTime	string	true	更新时间
pageNo	int	true	页面编号
pageSize	int	true	页面大小
totalCount	int	true	总数

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

{
  "data": [
    {
      "appId": "egyrfpkuyz52k8jakmb3",
      "domain": "egyrfpkuyz52k8jakmb3.vod.e-web.com.cn",
      "cname": "egyrfpkuyz52k8jakmb3.vod.e-web.com.cn.a.bdydns.com",
      "cnameValid": false,
      "type": "SYSTEM",
      "status": "RUNNING",
      "description": "系统默认域名",
      "enableHttps": false,
      "createTime": "2024-07-26T03:06:54Z",
      "updateTime": "2024-07-31T13:02:09Z"
    },
    {
      "appId": "egyrfpkuyz52k8jakmb3",
      "domain": "tencent.com",
      "cname": "tencent.com.a.bdydns.com",
      "cnameValid": false,
      "type": "USER",
      "status": "RUNNING",
      "description": "",
      "enableHttps": false,
      "createTime": "2024-08-08T08:50:55Z",
      "updateTime": "2024-08-08T08:50:55Z"
    }
  ],
  "pageNo": 1,
  "pageSize": 2,
  "totalCount": 3
}

创建自定义域名

按照给出的域名，创建CDN加速域名，注意：用户给出的域名需通过备案

请求语法

POST /v2/domains HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	类型	必选	说明
domain	string	是	用户的域名

请求示例

POST /v2/domains  HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

{
    "domain": "test.mini.e-web.com.cn"
}

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

启用域名

启用域名后，可对该域名下的资源进行分发加速

请求语法

POST /v2/domains/{domain}/enable HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	path	string	是

返回示例

请求示例

POST /v2/domains/test.mini.e-web.com.cn/enable HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

停用域名

停用域名后，该域名下的资源将停止分发加速

请求语法

POST /v2/domains/{domain}/disable HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	path	string	是

返回示例

请求示例

POST /v2/domains/test.mini.e-web.com.cn/disable HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

验证域名是否合法

对给出的域名进行校验，验证域名的归属权、icp是否备案。如果归归属权验证失败，则返回归属权验证信息。

请求语法

GET /v2/domains/{domain}/valid HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	path	string	是

请求示例

GET /v2/domains/test.mini.e-web.com.cn/valid  HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

名称	类型	必选	说明
valid	boolean	true	域名验证是否通过，取值 true 或 false
message	string	true	解释信息，仅当valid为false时有值，给出校验不通过的原因
verifyType	string	true	当valid为false，且域名没有在百度云CDN校验归属权时，该字段有值，固定值为DNS_TXT
verifyDetails	object	true	当verifyType值为DNS_TXT时，当前字段给出待校验的信息。用户需要自行将自己的域名解析到targetTxt。给出的待验证信息是个列表，验证任意一个均可。
verifyDomain	string	true	用户待验证的子域名
targetTxt	string	true	待验证子域名应当解析的TXT

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

{
    "valid": false,
    "message": "the domain has no icp record",
    "verifyType": "DNS_TXT",
    "verifyDetails": [
        {
            "verifyDomain": "test.mini.e-web.com.cn",
            "targetTxt": "7749325c-3e25c13a",
            "zone": "mysite.com",
            "record": "bdy-verify"
        },
        {
            "verifyDomain": "test.mini.e-web.com.cn",
            "targetTxt": "7749325c-19b4a5df",
            "zone": "mysite.com",
            "record": "bdy-verify.video"
        }
    ]
}

配置访问控制

按照指定的规则可对域名下资源进行权限配置

请求语法

POST /v2/domains/{domain}/config HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
domain	path	string	是
appId	query	string	否	appId，不提供则使用默认app
body	body	object	否
cacheTTL	body	[CacheTtlInfo]	是
type	body	string	是	"suffix"表示文件名后缀，"path"表示url中的目录，"code"表示异常码缓存(如可以配置404缓存100s) ，“exactPath”表示路径完全匹配
value	body	string	是	type所指定类型的配置规则
weight	body	int	是	权重，0-100的整数，权重越高优先级越高，默认为0，优先级在为code类型下是没有作用的，可以忽略
ttl	body	int	是	缓存时间，单位为秒
overrideOrigin	body	boolean	是	存是否遵循源站，默认true。overrideOrigin=true表示不遵循源站，按照该条配置规则缓存
httpsConfig	body	object	是	https配置
enabled	body	boolean	是	是否启用https
certId	body	string	否	当enabled=true时此项为必选，为SSL证书服务返回的证书ID，当enablae=false且certId=""时解绑domain当前绑定的certId，否则当enabled=false时此项无效
httpRedirect	body	boolean	否	为true时将HTTP请求重定向到HTTPS（重定向状态码为httpRedirectCode所配置）。默认为false，当enabled=false时此项无效，不可与httpsRedirect同时为true
httpRedirectCode	body	int	否	重定向状态码。可选值301/302，默认302，当enabled=false此项无效，httpRedirect=false此项无效
httpsRedirect	body	boolean	否	为true时将HTTPS请求重定向到HTTP（重定向状态码为httpsRedirectCode所配置）。默认为false，当enabled=false时此项无效，不可与httpRedirect同时为true
httpsRedirectCode	body	int	否	重定向状态码。可选值301/302，默认302，当enabled=false此项无效，httpsRedirect=false此项无效
noRedirectedUAs	body	[string]	否	重定向时，排除包含特定UA的请求。数组元素不能超过10个，当enabled=false时此项无效，httpsRedirect、httpsRedirect有且仅有一个为true时，设置的此项有效（noRedirectedUAs=[]表示清空该项的历史值）
http2Enabled	body	boolean	否	是否开启HTTP2特性。默认true，当enabled=false此项无效
verifyClient	body	boolean	否	是否开启HTTPS双向认证。默认为false，只有开启了服务端HTTPS认证才可以开启该配置
sslProtocols	body	[string]	否	设置访问TLS版本。默认为支持从TLSv1.0到TLSv1.3的版本，也可以主动设置为"TLSv1.0"、"TLSv1.1"、"TLSv1.2"、"TLSv1.3"四个中的一个或多个，该参数不能为空list，当enabled=false时此项无效，此项一般取默认值，无需设置
certificate	body	object	否	SSL证书，当enabled=true时有效
+ certName	body	string	是
+ certServerData	body	string	是
+ certPrivateData	body	string	是
+ certLinkData	body	string	是
cors	body	CorsInfo	是
allow	body	string	是	是否允许跨域
originList	body	[string]	否	处理跨域时，支持的域名列表。示例参考https://cloud.baidu.com/doc/CDN/s/tjxzi2d7t
refererACL	body	object	是	- blackList：可选项，list类型，表示referer黑名单列表，支持使用通配符，不需要加protocol，如设置某个黑名单域名，设置为"www.xxx.com"形式即可，而不是"http://www.xxx.com"。 - whiteList：可选项，list类型，表示referer白名单列表，支持通配符，同样不需要加protocol。
blackList	body	[string]	否
whiteList	body	[string]	否
allowEmpty	body	boolean	是	必选项，Bool类型，表示是否允许空referer访问，默认为true即允许空referer访问。
ipACL	body	object	是	ip限制
blackList	body	[string]	否
whiteList	body	[string]	否
userAgentACL	body	object	是	user-agent限制
blackList	body	[string]	否
whiteList	body	[string]	否
requestAuth	body	object	是	自定义高级鉴权
type	body	string	是	A/B/C 三种鉴权方式
key1	body	string	是	主鉴权key,输入大小写字母，数字，长度6到32位
key2	body	string	否	副鉴权Key，输入大小写字母，数字，长度6到32位
timeout	body	int	否	鉴权有效时间，A/B/C三类鉴权方式都支持，单位为秒；URL鉴权的过期时间为指定“timestamp+timeout”；默认为1800。UTC时间
whiteList	body	[string]	否	白名单列表，在该名单中的文件名不需要鉴权
signArg	body	string	否	签名参数名，只对type C生效
timeArg	body	string	否	时间戳参数名，只对type C生效
timestampFormat	body	string	否	鉴权时间格式。可选值为"10"、"16"、"yyyyMMDDhhmm"，分别表示10进制时间格式，16进制时间格式、字符串类的时间格式。其中，只有type为B时才可以取值"yyyyMMDDhhmm"

请求示例

POST /v2/domains/test.mini.e-web.com.cn/config HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

{
    "cacheTTL": [
        {
            "type": "suffix",
            "value": ".jpg",
            "ttl": 0,
            "weight": 100
        }
    ]
}

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

创建通知

创建通知，用于工作流任务完成时发送回调。

请求语法

POST /v2/notification HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	中文名	说明
name	body	string	是	通知名
description	body	string	否
callbackUrl	body	string	是
token	body	string	否		用户自定义回调用户服务器时的校验token，默认为空字符串表示不计算鉴权。如需关闭已开启的token校验，请修改token=""。VOD通知服务在回调用户服务器时，以此token计算校验串，用户服务在接收回调时以同样方式计算校验串进行比对。计算方法见https://cloud.baidu.com/doc/VideoWorks/s/ejz21yogr

请求示例

POST /v2/notification HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

{
    "name": "aaaa",
    "description": "描述信息",
    "callbackUrl": "http://aaaa.com/callback",
    "token": "my_random_token"
}

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

查询通知列表

分页获取创建的通知列表

请求语法

GET /v2/notification?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	说明
pageNo	query	int	否
pageSize	query	int	否
sortBy	query	string	否	枚举值：CREATE_TIME，NAME，STATUS，UPDATE_TIME。可以在字段名前加负号表示逆序，例如 -NAME

请求示例

GET /v2/notification?pageSize=100 HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

{
  "data": [
    {
      "appId": "egyrfpkuyz52k8jakmb3",
      "name": "aaaa",
      "description": "描述信息",
      "callbackUrl": "http://aaaa.com/callback",
      "token": "my_random_token",
      "status": "RUNNING"
    },
    {
      "appId": "egyrfpkuyz52k8jakmb3",
      "name": "test2",
      "description": "",
      "callbackUrl": "https://baidu.com/vod2",
      "token": "boxbcetestbaiducom8899vod2",
      "status": "RUNNING"
    }
  ],
  "pageNo": 1,
  "pageSize": 2,
  "totalCount": 8
}

修改通知

修改已创建的通知

请求语法

PUT /v2/notification/{name} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	中文名	说明
name	path	string	是
appId	query	string	否		若不提供则使用默认app
body	body	object	否
name	body	string	是	通知名	name must be 4-128 characters long, and only contain letters, numbers, _ or -
description	body	string	否
callbackUrl	body	string	是
token	body	string	否
enable	body	boolean	否		是否启用通知，默认为true

请求示例

PUT /v2/notification/test HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

{
    "name": "test",
    "description": "描述信息",
    "callbackUrl": "http://aaaa.com/callback",
    "token": "my_random_token_2"
}

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

查询通知

查询已创建的通知详情

请求语法

GET /v2/notification/{name} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	中文名	说明
name	path	string	是

请求示例

GET /v2/notification/test HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

{
    "appId": "egyrfpkuyz52k8jakmb3",
    "name": "test",
    "description": "",
    "callbackUrl": "https://baidu.com/vod2",
    "token": "boxbcetestbaiducom8899vod2",
    "status": "RUNNING"
}

删除通知

创建通知，用于工作流任务完成时发送回调。

请求语法

DELETE /v2/notification/{name} HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: <utc-date-string>
connection: keep-alive
accept: */*
host: vod.bj.baidubce.com
x-bce-request-id: <bce-request-id>
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

名称	位置	类型	必选	中文名	说明
name	path	string	是

请求示例

DELETE /v2/notification/test HTTP/1.1
accept-encoding: gzip, deflate
x-bce-date: 2024-03-24T13:08:44Z
host: vod.bj.baidubce.com
accept: */*
connection: keep-alive
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2024-03-24T13:08:44Z/1800/host;x-date/7e21c9cf1e4e2cc6921a407a388fe98df122c53b9f509043d841be76eb09a1f9

响应头域

无特殊响应头域。

响应参数

无

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 6bae5cb3-97d1-4b1a-b8b6-0ad577c1d481
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 2024 13:08:44 GMT
Content-Type: application/json;charset=UTF-8

附录

CacheTtlInfo

名称	类型	必选	说明
type	string	true	"suffix"表示文件名后缀，"path"表示url中的目录，"code"表示异常码缓存(如可以配置404缓存100s) ，“exactPath”表示路径完全匹配
value	string	true	type所指定类型的配置规则
weight	int	true	权重，0-100的整数，权重越高优先级越高，默认为0，优先级在为code类型下是没有作用的，可以忽略
ttl	int	true	缓存时间，单位为秒
overrideOrigin	boolean	true	存是否遵循源站，默认true。overrideOrigin=true表示不遵循源站，按照该条配置规则缓存

CorsInfo

名称	类型	必选	约束	中文名	说明
allow	string	true			是否允许跨域
originList	[string]	false			处理跨域时，支持的域名列表。示例参考https://cloud.baidu.com/doc/CDN/s/tjxzi2d7t

处理设置接口

统计分析接口

百度智能云

智能点播平台 VOD

智能点播平台 VOD

全局设置接口

查询CDN域名

删除自定义域名

查询CDN域名列表(分页)

创建自定义域名

启用域名

停用域名

验证域名是否合法

配置访问控制

创建通知

查询通知列表

修改通知

查询通知

删除通知

附录

CacheTtlInfo

CorsInfo