查询加速域名

更新时间： 2019/06/05 14:36

功能介绍

查询加速域名信息。

URI

GET /v1.0/cdn/domains

请求消息

请求参数

请求参数如表1所示。

表1 请求参数
名称	是否必选	参数类型	说明
domain_name	否	String	加速域名，采用模糊匹配的方式。（长度限制为1-255字符）。
business_type	否	String	加速域名的业务类型。取值： web（图片及小文件分发） download（大文件下载加速） video（视音频点播加速）。
domain_status	否	String	加速域名状态。取值意义： online表示“已开启” offline表示“已停用” configuring表示“配置中” configure_failed表示“配置失败” checking表示“审核中” check_failed表示“审核失败” deleting表示“删除中”。
service_area	否	String	华为云CDN提供的加速服务范围，包含： mainland_china outside_mainland_china global。
domain_origin	否	String	域名源站。
page_size	否	int	每页的数量，取值范围1-10000，不设值时默认值为30。
page_number	否	int	查询的页码。取值范围1-65535，不设值时默认值为1。
user_domain_id	否	String	域名所属用户的domain_id。
enterprise_project_id	否	String	企业项目ID。该参数仅对开启了企业项目功能的用户生效，不传表示查询default项目。"ALL"表示查询所有该用户已授权项目的资源。

响应消息

响应参数

响应参数如表2所示。

表2 响应参数
名称	参数类型	说明
total	int	总条数。
domains	array	查询结果数据，详细说明见下表。

domains参数说明

domains参数说明如表3所示。

表3 domains参数说明
名称	参数类型	说明
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	源站域名或源站IP，IP仅支持IPv4，多个源站IP之间以英文逗号间隔，最多支持10个源站IP。
domain_origin_host	object	域名回源设置信息。
https_status	int	是否开启HTTPS加速。
create_time	long	域名创建时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。
modify_time	long	域名修改时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。
disabled	int	封禁状态（0代表未禁用；1代表禁用）。
locked	int	锁定状态（0代表未锁定；1代表锁定）。
third_part_cdn	String	第三方CDN，在添加Header时会根据不同的第三方设置相应的Header。
service_area	String	华为云CDN提供的加速服务范围，包含：mainland_china、outside_mainland_china、global。
range_status	String	Range回源状态。
follow_status	String	302回源跟随状态。
enterprise_project_id	String	当用户开启企业项目功能时返回该参数，表示域名资源所属企业项目ID。

sources参数说明

sources参数说明如表4所示。

表4 sources参数说明
名称	参数类型	说明
domain_id	String	域名ID。
ip_or_domain	String	源站IP或者域名。
origin_type	Stirng	源站类型取值：ipaddr、 domain、obs_bucket，分别表示：源站IP、源站域名、OBS桶访问域名。
active_standby	int	主备状态（1代表主站；0代表备站）,主源站必须存在，备源站可选，OBS桶不能有备源站。

domain_origin_host参数说明

domain_origin_host参数说明如表5所示。

表5 domain_origin_host参数说明
名称	参数类型	说明
domain_id	String	域名ID。
origin_host_type	String	回源的类型。
customize_domain	String	自定义回源域名。

示例

请求示例
请求路径示例

/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0

响应示例

{
  "total" : 1,
  "domains" : [ {
    "sources" : [ {
      "domain_id" : "ab1234a*********************g56",
      "origin_type" : "ipaddr",
      "ip_or_domain" : "10.62.53.75",
      "active_standby" : 1
    } ],
    "cname" : "www.example.com.c.test.com",
    "id" : "ab1234a*********************g56",
    "user_domain_id" : "1e234********************441",
    "domain_name" : "www.example.com",
    "business_type" : "web",
    "service_area" : "mainland_china",
    "domain_status" : "online",
    "https_status" : null,
    "create_time" : 1516861994806,
    "modify_time" : 1532405346365,
    "domain_origin_host" : {
      "domain_id" : "ab1234a*********************g56",
      "origin_host_type" : "customize",
      "customize_domain" : "www.xxxx.com"
    },
    "disabled" : 0,
    "locked" : 0,
    "third_part_cdn" : null,
    "range_status" : "off",
    "enterprise_project_id" : null
  } ]
}