查询CDN域名。
接口说明
获取 CDN 域名配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mpserverless:DescribeCdnDomain |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TenantId |
string |
否 |
租户 ID。 |
UNIGTXQTAO |
| SpaceId |
string |
是 |
服务空间 ID。 |
mp-05c3aa1c-****-43ae-a03d-61eff91c592e |
| Type |
string |
是 |
支持对云存储和静态网站自定义域名进行管理:
|
FILE |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| SpaceId |
string |
服务空间 ID。 |
mp-65e6491b-****-4c2e-b202-7f0036eb2713 |
| RequestId |
string |
请求 ID。 |
E8A2FA95-6F70-****-971C-34C27485441D |
| ServiceStatus |
string |
|
IN_SERVICE |
| DomainName |
string |
CDN 域名。 |
mp-65e6491b-****-4c2e-b202-7f0036eb2713.cdn.bspapp.com |
| CorsConfig |
object |
跨域配置。 |
|
| AllowOrigin |
string |
设置跨域校验规则,默认为“*”,跨域校验规则为:
|
https://www.baidu.com |
| ConfigId |
string |
配置 ID。 |
274436853071**** |
| AccessOriginControl |
boolean |
|
true |
| RefererConfig |
object |
防盗链配置。 |
|
| Type |
string |
说明
黑名单和白名单互斥,同一时间您只能选择其中一种方式。 |
white |
| ReferList |
string |
名单列表,多个用半角逗号(,)分隔。 说明
Referer 防盗链规则的总长度最长不超过 60 KB。 |
a*b.example.com |
| AllowEmpty |
string |
是否允许空 referer 字段访问 CDN 资源。取值:
|
on |
| DisableAst |
string |
是否使用精确匹配模式,控制“名单列表”项中填写的域名是否为精确匹配。如果勾选(on)则精确匹配域名。
|
a*b.example.com |
| ConfigId |
string |
配置 ID。 |
28048528682**** |
| IpConfig |
object |
IP 黑白名单配置。 |
|
| Type |
string |
说明
黑名单和白名单互斥,同一时间您只能选择其中一种方式。 |
black |
| IpList |
string |
更多参考: IP 地址校验模式。 |
183.157.108.82,140.205.147.26 |
| ConfigId |
string |
配置 ID。 |
25623800702**** |
| UaConfig |
object |
UA 客户端标识黑白名单配置。 |
|
| Type |
string |
说明
黑名单和白名单互斥,同一时间您只能选择其中一种方式。 |
white |
| UaList |
string |
填写 User-Agent,支持通配符号*(匹配任意字符串)和多个值(多个值用|分割。例如:*curl*|*IE*|*chrome*|*firefox*)。 说明
如果您需要对用户请求中携带了 User-Agent 请求头,但是值为空的情况做访问控制,您可以使用参数 this-is-empty-ua 来表示 User-Agent 值为空。 |
*curl*|*IE*|*chrome*|*firefox* |
| ConfigId |
string |
配置 ID。 |
25950108534**** |
| AuthConfig |
object |
CDN 鉴权配置,仅“FILE”模式下有效。 |
|
| AuthType |
string |
鉴权类型,枚举值:
更多参考:鉴权方式及原理说明。 |
no_auth |
| AuthKey |
string |
鉴权密钥,6~128 位,用于计算鉴权签名。 |
SL4ZB**** |
| AuthDelta |
integer |
鉴权默认有效时长(秒)。 |
3600 |
| configId |
string |
配置 ID。 |
25950108534**** |
示例
正常返回示例
JSON格式
{
"SpaceId": "mp-65e6491b-****-4c2e-b202-7f0036eb2713",
"RequestId": "E8A2FA95-6F70-****-971C-34C27485441D",
"ServiceStatus": "IN_SERVICE",
"DomainName": "mp-65e6491b-****-4c2e-b202-7f0036eb2713.cdn.bspapp.com",
"CorsConfig": {
"AllowOrigin": "https://www.baidu.com",
"ConfigId": "274436853071****",
"AccessOriginControl": true
},
"RefererConfig": {
"Type": "white",
"ReferList": "a*b.example.com",
"AllowEmpty": "on",
"DisableAst": "a*b.example.com",
"ConfigId": "28048528682****"
},
"IpConfig": {
"Type": "black",
"IpList": "183.157.108.82,140.205.147.26",
"ConfigId": "25623800702****"
},
"UaConfig": {
"Type": "white",
"UaList": "*curl*|*IE*|*chrome*|*firefox*",
"ConfigId": "25950108534****"
},
"AuthConfig": {
"AuthType": "no_auth",
"AuthKey": "SL4ZB****",
"AuthDelta": 3600,
"configId": "25950108534****\n"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。