文档

DescribeCdnDomain - 获取CDN配置

接口说明

获取 cdn 域名配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TenantIdstring

租户 ID。

UNIGTXQTAO
SpaceIdstring

服务空间 ID。

mp-05c3aa1c-****-43ae-a03d-61eff91c592e
Typestring

支持对云存储和静态网站自定义域名进行管理:

  • FILE 云存储 CDN
  • WEB 静态网站托管 CDN(前提是已经绑定自定义 CDN)
FILE

返回参数

名称类型描述示例值
object
SpaceIdstring

服务空间 ID。

mp-65e6491b-****-4c2e-b202-7f0036eb2713
RequestIdstring

请求 ID。

E8A2FA95-6F70-****-971C-34C27485441D
ServiceStatusstring
  • IN_SERVICE:CDN 服务中。
  • PAUSED:CDN 已停止服务,请检查您的账户余额、套餐到期日或者资源用量是否超额。
IN_SERVICE
DomainNamestring

CDN 域名。

mp-65e6491b-****-4c2e-b202-7f0036eb2713.cdn.bspapp.com
CorsConfigobject

跨域配置。

AllowOriginstring

设置跨域校验规则,默认为“*”,跨域校验规则为:

  • 设置为“*”,不论用户请求里面是否携带“Origin”参数,也不论携带的“Origin”参数为何值,都固定返回“Access-Control-Allow-Origin:*”。
  • 跨域资源共享的响应头值设置了单个或者多个值(多个值之间用“,”分隔)。
    • 如果用户请求头里携带的“Origin”参数值与被设置的任意一个值精确匹配,就会响应对应的跨域头。
    • 如果都没有精确匹配上,则不响应跨域头。
  • 设置为通配符域名,则会校验请求头中 Origin 值是否能匹配上。
https://www.baidu.com
ConfigIdstring

配置 ID。

274436853071****
AccessOriginControlboolean
  • true:开启跨域验证,每次请求都会检查是否符合跨域规则。
  • false:不开启跨域校验,固定返回已配置的跨域头。
true
RefererConfigobject

防盗链配置。

Typestring
  • white: 白名单
  • black: 黑名单
说明 黑名单和白名单互斥,同一时间您只能选择其中一种方式。
white
ReferListstring

名单列表,多个用半角逗号(,)分隔。

说明 Referer 防盗链规则的总长度最长不超过 60 KB。
a*b.example.com
AllowEmptystring

是否允许空 referer 字段访问 CDN 资源。取值:

  • on:允许。
  • off(默认值):禁止。
on
DisableAststring

是否使用精确匹配模式,控制“名单列表”项中填写的域名是否为精确匹配。如果勾选(on)则精确匹配域名。

  • 取值为 on 时:
    • 支持精确匹配。
      • 名单列表填写 example.com,匹配 example.com。
      • 名单列表填写 a*b.example.com,匹配 a<任意字符>b.example.com。
    • 不支持后缀匹配。
  • 取值为 off(默认值)时:
    • 不支持精确匹配。
    • 支持后缀匹配。
      • 名单列表填写 example.com,匹配 example.com 和<任意字符>.example.com。
      • 名单列表填写 a*b.example.com,匹配 a<任意字符>b.example.com 和<任意字符>.a<任意字符>b.example.com。
a*b.example.com
ConfigIdstring

配置 ID。

28048528682****
IpConfigobject

IP 黑白名单配置。

Typestring
  • white: 白名单
  • black: 黑名单
说明 黑名单和白名单互斥,同一时间您只能选择其中一种方式。
black
IpListstring
  • IP 列表,多个用半角逗号(,)分隔。支持设置网段。
  • 最多可配置约 700 个 IPv6 地址,2000 个 IPv4 地址。

更多参考: IP 地址校验模式

183.157.108.82,140.205.147.26
ConfigIdstring

配置 ID。

25623800702****
UaConfigobject

UA 客户端标识黑白名单配置。

Typestring
  • white: 白名单
  • black: 黑名单
说明 黑名单和白名单互斥,同一时间您只能选择其中一种方式。
white
UaListstring

填写 User-Agent,支持通配符号*(匹配任意字符串)和多个值(多个值用|分割。例如:*curl*|*IE*|*chrome*|*firefox*)。

说明 如果您需要对用户请求中携带了 User-Agent 请求头,但是值为空的情况做访问控制,您可以使用参数 this-is-empty-ua 来表示 User-Agent 值为空。
*curl*|*IE*|*chrome*|*firefox*
ConfigIdstring

配置 ID。

25950108534****
AuthConfigobject

CDN 鉴权配置,仅“FILE”模式下有效。

AuthTypestring

鉴权类型,枚举值:

  • no_auth 当前未开启鉴权。
  • type_a A 方式鉴权。
  • type_b B 方式鉴权。
  • ype_c C 方式鉴权。

更多参考:鉴权方式及原理说明

no_auth
AuthKeystring

鉴权秘钥,6~128 位,用于计算鉴权签名。

SL4ZB****
AuthDeltainteger

鉴权默认有效时长(秒)。

3600
configIdstring

配置 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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈