查询加速域名
功能介绍
查询加速域名信息。
URI
GET /v1.0/cdn/domains
请求消息
请求参数
请求参数如表1所示。
名称 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。 |
user_domain_id |
否 |
String |
域名所属用户的domain_id。 |
enterprise_project_id |
否 |
String |
企业项目ID。该参数仅对开启了企业项目功能的用户生效,不传表示查询default项目。"ALL"表示查询所有该用户已授权项目的资源。 |
请求示例
请求路径示例
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0
响应消息
响应参数
domains参数说明
domains参数说明如表3所示。
名称 |
参数类型 |
描述 |
---|---|---|
id |
String |
加速域名ID。 |
domain_name |
String |
加速域名。 |
business_type |
String |
域名业务类型,若为web,则表示类型为网站加速;若为download,则表示业务类型为下载加速;若为video,则表示业务类型为点播加速。 |
user_domain_id |
String |
域名所属用户的domain_id。 |
domain_status |
String |
加速域名状态。取值意义:online表示“已开启”、offline表示“已停用”、configuring表示“配置中”、configure_failed表示“配置失败”、checking表示“审核中”、check_failed表示“审核失败”、deleting表示“删除中”。 |
cname |
String |
加速域名对应的CNAME。 |
sources |
Array of objects |
源站域名或源站IP,IP仅支持IPv4,多个源站IP之间以英文逗号间隔,最多支持10个源站IP。详细说明见表4。 |
domain_origin_host |
Object |
域名回源设置信息。详细说明见表5。 |
create_time |
Integer |
域名创建时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 |
modify_time |
Integer |
域名修改时间,相对于UTC 1970-01-01到当前时间相隔的毫秒数。 |
auto_refresh_preheat |
Integer |
自动刷新预热开关(0代表关闭,1代表开启) |
disabled |
Integer |
封禁状态(0代表未禁用;1代表禁用)。 |
locked |
Integer |
锁定状态(0代表未锁定;1代表锁定)。 |
service_area |
String |
华为云CDN提供的加速服务范围,包含:mainland_china、outside_mainland_china、global。 |
range_status |
String |
Range回源状态。 |
follow_status |
String |
302回源跟随状态。 |
https_status |
Integer |
HTTPS证书是否启用。0:不启用,此时无需填写证书及私钥参数;1:启用HTTPS加速并协议跟随回源;2:启用HTTPS加速并HTTP回源,开启时需要传递证书及私钥。 |
origin_status |
String |
回源开关("off"/"on") |
enterprise_project_id |
String |
当用户开启企业项目功能时返回该参数,表示域名资源所属企业项目ID。 |
sources参数说明
sources参数说明如表4所示。
名称 |
参数类型 |
描述 |
---|---|---|
domain_id |
String |
域名ID。 |
ip_or_domain |
String |
源站IP或者域名。 |
origin_type |
String |
源站类型取值:ipaddr、 domain、obs_bucket,分别表示:源站IP、源站域名、OBS桶访问域名。 |
active_standby |
Integer |
主备状态(1代表主站;0代表备站),主源站必须存在,备源站可选,OBS桶不能有备源站。 |
domain_origin_host参数说明
domain_origin_host参数说明如表5所示。
- 响应示例
{ "total": 34, "domains": [{ "sources": [{ "domain_id": "16577532e****************6b3e5ae6b", "origin_type": "ipaddr", "ip_or_domain": "1.2.3.6", "active_standby": 1 }], "cname": "www.example.com.c.test.com", "id": "16577532e3fc4684844129b6b3e5ae6b", "user_domain_id": "a6922b75*******bc22d14c5", "domain_name": "www.example.com", "business_type": "web", "service_area": "mainland_china", "domain_status": "online", "https_status": 0, "create_time": 1579423074435, "modify_time": 1579423140535, "auto_refresh_preheat":0, "domain_origin_host": { "domain_id": "16577532e****************6b3e5ae6b", "origin_host_type": "accelerate", "customize_domain": "www.example.com" }, "disabled": 0, "locked": 0, "range_status": "off", "follow_status": "off", "origin_status": "on", "enterprise_project_id": "0" }] }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
