更新时间:2024-04-23 GMT+08:00
分享

查询加速域名详情

功能介绍

加速域名详情信息接口。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1.0/cdn/configuration/domains/{domain_name}

表1 路径参数

参数

是否必选

参数类型

描述

domain_name

String

加速域名名称。

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用账号调用接口时,该参数必传。

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

domain

DomainsDetail object

域名信息。

表5 DomainsDetail

参数

参数类型

描述

id

String

加速域名ID。

domain_name

String

加速域名。

business_type

String

域名业务类型,若为web,则表示类型为网站加速;若为download,则表示业务类型为文件下载加速;若为video,则表示业务类型为点播加速;若为wholeSite,则表示类型为全站加速。

domain_status

String

加速域名状态。取值意义:

  • online表示“已开启”
  • offline表示“已停用”
  • configuring表示“配置中”
  • configure_failed表示“配置失败”
  • checking表示“审核中”
  • check_failed表示“审核未通过”
  • deleting表示“删除中”。

cname

String

加速域名对应的CNAME。

sources

Array of SourcesDomainConfig objects

源站配置。

https_status

Integer

是否开启HTTPS加速。 0:代表未开启HTTPS加速; 1:代表开启HTTPS加速,且回源方式为协议跟随; 2:代表开启HTTPS加速,且回源方式为HTTP; 3:代表开启HTTPS加速,且回源方式为HTTPS。

create_time

Long

域名创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

update_time

Long

域名修改时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。

disabled

Integer

封禁状态(0代表未禁用;1代表禁用)。

locked

Integer

锁定状态(0代表未锁定;1代表锁定)。

service_area

String

华为云CDN提供的加速服务范围,包含:mainland_china中国大陆、outside_mainland_china中国大陆境外、global全球。

表6 SourcesDomainConfig

参数

参数类型

描述

origin_type

String

源站类型。

  • ipaddr:源站IP;
  • domain:源站域名;
  • obs_bucket:OBS桶域名;
  • third_bucket:第三方桶。

origin_addr

String

源站IP或者域名。

priority

Integer

源站优先级,70:主,30:备。

obs_web_hosting_status

String

是否开启OBS静态网站托管,源站类型为obs_bucket时传递,off:关闭,on:开启。

http_port

Integer

HTTP端口,默认80,端口取值取值范围1-65535。

https_port

Integer

HTTPS端口,默认443,端口取值取值范围1-65535。

host_name

String

回源HOST,默认加速域名。

obs_bucket_type

String

OBS桶源站类型:

  • “private” 私有桶;
  • “public” 公有桶,默认为公有桶。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

ErrMsg object

用于返回具体的错误码和错误消息

表8 ErrMsg

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains/www.example.com?enterprise_project_id=1

响应示例

状态码: 200

成功响应。

{
  "domain" : {
    "sources" : [ {
      "origin_type" : "ipaddr",
      "origin_addr" : "0.0.0.0",
      "priority" : 70,
      "obs_web_hosting_status" : "string",
      "http_port" : 80,
      "https_port" : 443,
      "host_name" : "string"
    } ],
    "cname" : "www.example.com.c.example2.com",
    "id" : "12a***********************345d671",
    "domain_name" : "www.example.com",
    "business_type" : "web",
    "service_area" : "mainland_china",
    "domain_status" : "online",
    "https_status" : 0,
    "create_time" : 1516861994806,
    "update_time" : 1532405346365,
    "disabled" : 0
  }
}

状态码

状态码

描述

200

成功响应。

400

错误响应。

错误码

请参见错误码

分享:

    相关文档

    相关产品