查询加速域名
功能介绍
查询加速域名
URI
GET /v1.0/cdn/domains
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_name |
否 |
String |
加速域名,采用模糊匹配的方式。(长度限制为1-255字符)。 |
business_type |
否 |
String |
加速域名的业务类型。取值:
|
domain_status |
否 |
String |
加速域名状态。取值意义:
|
service_area |
否 |
String |
华为云CDN提供的加速服务范围,包含:
|
page_size |
否 |
Integer |
每页加速域名的数量,取值范围1-10000,默认值为30。 |
page_number |
否 |
Integer |
查询的页码,即:从哪一页开始查询,取值范围1-65535,默认值为1。 |
show_tags |
否 |
Boolean |
展示标签标识 true:展示 false:不展示。 |
exact_match |
否 |
Boolean |
精准匹配 true:开启 false:关闭。 |
enterprise_project_id |
否 |
String |
当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总条数。 |
domains |
Array of Domains objects |
域名信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
加速域名ID。 |
domain_name |
String |
加速域名。 |
business_type |
String |
域名业务类型,若为web,则表示类型为网站加速;若为download,则表示业务类型为文件下载加速;若为video,则表示业务类型为点播加速;若为wholeSite,则表示类型为全站加速。 |
domain_status |
String |
加速域名状态。取值意义:
|
cname |
String |
加速域名对应的CNAME。 |
sources |
Array of Sources objects |
源站配置。 |
domain_origin_host |
DomainOriginHost object |
域名回源HOST配置。 |
https_status |
Integer |
是否开启HTTPS加速。 |
create_time |
Long |
域名创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 |
modify_time |
Long |
域名修改时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 |
disabled |
Integer |
封禁状态(0代表未禁用;1代表禁用)。 |
locked |
Integer |
锁定状态(0代表未锁定;1代表锁定)。 |
auto_refresh_preheat |
Integer |
自动刷新预热(0代表关闭;1代表打开)。 |
service_area |
String |
华为云CDN提供的加速服务范围,包含:mainland_china中国大陆、outside_mainland_china中国大陆境外、global全球。 |
range_status |
String |
Range回源状态。 |
follow_status |
String |
回源跟随状态。 |
origin_status |
String |
是否暂停源站回源(off代表关闭 on代表开启)。 |
banned_reason |
String |
域名禁用原因。 |
locked_reason |
String |
域名锁定原因。 |
enterprise_project_id |
String |
当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,不传表示查询默认项目。注意:当使用子账号调用接口时,该参数必传。 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。 |
tags |
Array of EpResourceTag objects |
标签信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
domain_id |
String |
加速域名id。 |
ip_or_domain |
String |
源站IP(非内网IP)或者域名。 |
origin_type |
String |
源站类型取值:ipaddr:源站IP、 domain:源站域名、obs_bucket:OBS桶域名。 |
active_standby |
Integer |
主备状态,1代表主源站,0代表备源站。 |
enable_obs_web_hosting |
Integer |
是否开启OBS静态网站托管(0表示关闭,1表示则为开启),源站类型为obs_bucket时传递。 |
参数 |
参数类型 |
描述 |
---|---|---|
domain_id |
String |
域名ID。 |
origin_host_type |
String |
回源host的类型,accelerate:选择加速域名作为回源host域名, customize:使用自定义的域名作为回源host域名。 |
customize_domain |
String |
回源host域名。返回加速域名主源站设置的HOST域名,如果加速域名有多个主源站且对应多个回源HOST,则返回源站配置中的第一个主源站对应的HOST域名。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
ErrMsg object |
用于返回具体的错误码和错误消息 |
请求示例
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0
响应示例
状态码: 200
成功响应。
{ "total" : 1, "domains" : [ { "sources" : [ { "origin_type" : "ipaddr", "ip_or_domain" : "0.0.0.0", "active_standby" : 1 } ], "cname" : "www.example.com.c.test.com", "id" : "ab1234a*********************g56", "domain_name" : "www.example.com", "business_type" : "web", "service_area" : "mainland_china", "domain_status" : "online", "https_status" : 0, "create_time" : 1516861994806, "modify_time" : 1532405346365, "domain_origin_host" : { "domain_id" : "ab1234a*********************g56", "origin_host_type" : "customize", "customize_domain" : "www.example.com" }, "disabled" : 0, "locked" : 0, "range_status" : "off", "follow_status" : "off", "origin_status" : "on", "auto_refresh_preheat" : 0, "tags" : [ { "key" : "string", "value" : "string" } ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
成功响应。 |
400 |
错误响应。 |
错误码
请参见错误码。