文档首页 > > API参考> API(新版)> 域名操作> 查询加速域名

查询加速域名

分享
更新时间: 2019/09/10 GMT+08:00

功能介绍

查询加速域名信息。

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。

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"表示查询所有该用户已授权项目的资源。

请求示例

请求路径示例

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

响应消息

响应参数

响应参数如 表2所示。
表2 响应参数

名称

参数类型

描述

total

Integer

总条数。

domains

Array of objects

查询结果数据,详细说明见表3

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 of objects

源站域名或源站IP,IP仅支持IPv4,多个源站IP之间以英文逗号间隔,最多支持10个源站IP。详细说明见表4

domain_origin_host

Object

域名回源设置信息。详细说明见表5

https_status

Integer

是否开启HTTPS加速。

create_time

Integer

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

modify_time

Integer

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

disabled

Integer

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

locked

Integer

锁定状态(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

String

源站类型取值:ipaddr、 domain、obs_bucket,分别表示:源站IP、源站域名、OBS桶访问域名。

active_standby

Integer

主备状态(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

自定义回源域名。

  • 响应示例
    {
      "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
      } ]
    }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区