CDN加速

文档中心 API文档 域名管理 获取域名列表支持分页和模糊查询

获取域名列表支持分页和模糊查询

更新时间:2021-02-05 10:24:28
适用产品:网页加速、下载加速、全站加速、点播加速、直播加速、移动加速、云存储

接口描述

查询用户账号下所有的、或者指定的加速域名和状态,每个加速域名包含概要信息,返回的加速域名列表按照首字母顺序排序。

请求参数

参数名称类型必填描述
pageNumberint分页的页码,必须为大于0的正整数
pageSizeint分页的域名数据条数,必须大于0的正整数
serviceTypeString指定查询的服务类型,每次查询只能传一个类型,不传默认查全部类型
domainNameString指定查询的加速域名,允许多个域名,逗号分隔,不传默认查全部域名
queryTypeString查询加速域名的方式,可选值为:fuzzy_match表示模糊查询;full_match表示精确查询 不传默认为fuzzy_match,仅针对加速域名
startTimeString查询开始时间,支持范围为年月日时分秒,例如:20170101090000。时间含等于
endTimeString查询结束时间,查询时间段内存在的加速域名,时间含等于,不传默认查询所有
domainStatusString加速域名的状态,enabled表示已生效;disabled表示已禁用;deploying表示部署中;checking表示审核中;disabling:表示禁用中,不传默认查全部

返回参数

参数名称类型描述
http status codeinthttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-idString唯一标示的id,用于查询每次请求的任务 (适用全部接口)
totalCountint所有满足条件的数据总条数
totalPageNumberint总页数
pageNumberint返回数据的页码
pageSizeint每个页面的数据条数
resultListList<String>返回加速域名的状态信息
cnameString加速域名对应的CNAME域名,例如:7nt6mrh7sdkslj.cdn30.com
configFormNameString配置单名称
createTimeString时间格式为:20160323112310
domainIdint对应的域名ID
domainNameString加速域名名称
operatorString本次查询的操作者
originIpsString加速域名的回源IP
serviceTypeString加速域名的服务类型
domainStatusString加速域名的状态
deployVersionString部署版本号
cdnServiceStatusString域名是否启用CDN加速服务,Y和N
isEnabledString加速域名是否启用,Y和N

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidHTTPRequestThere was an error in the body of your HTTP request.400HTTP请求的正文中有一个错误
InternalErrorWe encountered an internal error. Please try again.500服务器异常,数据获取失败等内部错误
NotAcceptableThe accept header specified in your request is not acceptable.406可接受的MIME类型只能是json
PARAM_INVALIDparam: {0} is null or invalid.400参数{0}为空或不符合格式规范
WRONG_OPERATORWrong operator [$operator] for the customer.400提交人不对应客户

示例

示例说明
请求示例
复制
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "http://open.chinanetcenter.com/api/domain/domainList" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{
    "serviceType": "web", 
    "pageNumber": 1, 
    "pageSize": 15, 
    "domainName": ["a1.example.com","a2.example.com"], 
    "startTime": "20160113105210", 
    "endTime": "20171013105210", 
    "queryType": "fuzzy_match", 
    "domainStatus": "enabled"
}'
返回示例
复制
HTTP/1.1 200 OK
Server: openresty/1.11.2.2
Date: Mon, 27 May 2019 02:23:03 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 81
Connection: keep-alive
App-Name: service_confApi
x-cnc-request-id: aae132b5-704b-4f00
{
  "totalCount": 2,
  "pageNumber": 1,
  "pageSize": 100,
  "totalPageNumber": 1,
  "resultList": [
    {
      "cdnServiceStatus": "Y",
      "isEnabled": "Y",
      "domainId": "50659",
      "cname": "a1.example.com.wscdns.com",
      "configFormName": "nicole_209_网页加速",
      "createTime": "20161128105551",
      "domainName": "a1.example.com",
      "operator": "",
      "originIps": "1.2.3.5",
      "serviceType": "web",
      "domainStatus": "enabled",
      "deployVersion": "20161128105546"
    },
    {
      "cdnServiceStatus": "Y",
      "isEnabled": "Y",
      "domainId": "70203",
      "cname": "a2.example.com.ourplat.net",
      "configFormName": "nicole_482_网页加速",
      "createTime": "20160323112310",
      "domainName": "a2.example.com",
      "operator": "wenyh",
      "originIps": "1.1.1.1",
      "serviceType": "web",
      "domainStatus": "enabled",
      "deployVersion": "20170624170203275"
    }
  ]
}