获取域名列表
更新时间：2024-04-17 14:16:39
适用产品
应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速、网页加速、下载分发、全站加速、应用加速
接口描述
查询用户账号下所有的、或者指定cname-label的加速域名和状态，每个加速域名包含概要信息，返回的加速域名列表按照首字母顺序排序。 请注意：禁用的域名（即enabled值为false）不可修改。
- 调用URL： https://open.chinanetcenter.com/api/domain
- 调用方法：GET
- 限制说明：·接口返回结果支持xml和json格式。
调用频率
单用户调用频率：30/5min
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Params 参数
| 参数名称 | 描述 |
|---|---|
cname-labelString | 共用一级别名标示，可选入参，不选表示查询账号下所有域名
客户存在较多一级域名共用的需求，因此在接口中引入cname-label标识，即拥有相同cname-label的一组域名，共用一级cname。关于cname-label的具体使用方式和注意事项，请参看【创建加速域名】和【修改域名配置】接口 |
返回参数
响应头
| 参数名称 | 描述 |
|---|---|
http-status-codeInteger | httpstatus=202; 表示成功调用新增域名接口，可使用header中的x-cnc-request-id查看当前新增域名的部署情况 |
x-cnc-request-idString | 唯一标示的id，用于查询每次请求的任务 （适用全部接口） |
Body 参数
| 参数名称 | 描述 |
|---|---|
domain-listList | 域名列表 |
domain-nameString | 加速域名的名称 |
domain-idInteger | 对应的域名ID：域名ID，用于执行相关域名的查询、修改操作等。 |
cnameString | 加速域名对应的CNAME域名，例如：7nt6mrh7sdkslj.cdn30.com |
service-typeString | 加速域名的服务类型，取值：
web/web-https：网页加速/网页加速-https
wsa/wsa-https：全站加速/全站加速-https
vodstream/vod-https：点播加速/点播加速-https
download/dl-https：下载加速/下载加速-https
livestream/live-https/cloudv-live：直播加速/直播加速-https/云直播
appa/s-appa：应用加速/应用安全加速解决方案
1028 : Content Acceleration;
1115 : Dynamic Web Acceleration;
1369 : Media Acceleration - RTMP
1391 : Download Acceleration
1348 : Media Acceleration Live Broadcast
1551 : Floodshield |
statusString | 加速域名的部署状态：Deployed表示该加速域名配置完成部署；InProgress表示该加速域名配置的部署任务还在进行中，可能处于排队、部署中或失败任意一种状态 |
cdn-service-statusString | 加速域名的CDN服务状态：当取消加速域名CDN服务后，此项为false；当恢复加速域名CDN服务后，此项为true |
enabledString | 加速域名的启用状态：当禁用加速域名服务后，此项为false；当启用加速域名服务后，此项为true |
last-modifiedString | 域名最近修改时间，格式: 2024-01-01T22:30:00+08:00 |
billing-areasString | 计费区域 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| WRONG_OPERATOR | Operator [$operator] not exist. | 400 | 提交人不存在 |
| PARSE_PARAM_ERROR | Wrong enabled. | 400 | 入参解析错误，enabled错误 |
| WRONG_CUSTOMER_NAME | Wrong customer name. | 400 | 客户名称错误 |
| WRONG_CUSTOMER_ID | Wrong customer id. | 400 | 客户id错误 |
示例
XML示例1
- 请求示例 复制成功
#!/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 "https://open.chinanetcenter.com/api/domain" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/xml"
- 返回示例 复制成功
HTTP/1.1 202 Accepted Date: Fri, 17 May 2017 06:33:26 GMT Content-Type: application/xml;charset=utf-8 x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd <?xml version="1.0" encoding="UTF-8"?> <domain-list> <domain-summary> <domain-id>171190</domain-id> <domain-name>a.example.com</domain-name> <service-type>web</service-type> <status>Deployed</status> <enabled>true</enabled> <cdn-service-status>true</cdn-service-status> </domain-summary> <domain-summary> <domain-id>172260</domain-id> <domain-name>b.example.com</domain-name> <service-type>web</service-type> <status>Deployed</status> <enabled>true</enabled> <cdn-service-status>true</cdn-service-status> </domain-summary> </domain-list>
本篇文档内容对您是否有帮助？
有帮助
我要反馈