查询域名列表

最近更新时间:2021-08-24 09:52:44

查看PDF

GetCdnDomains

描述

本接口用于查询当前用户下所有域名列表信息,包含加速域名、域名ID、域名运行状态、产品类型、产品子类型、CNAME域名

  • 支持按域名模糊匹配过滤、域名状态过滤
  • 支持根据域名运行状态、产品类型筛选查询
  • 支持按照指定项目下的域名查询

请求语法

本接口请求需要包含指定目录/2016-09-01/domain/GetCdnDomains、公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 必选 类型及范围 说明
PageSize Long 分页大小,默认20,最大500,取值1~500间整数
PageNumber Long 取第几页。默认为1,取值1~10000
DomainName String 按域名过滤,默认为空,为空时代表当前用户下所有域名,域名长度最大255,不支持多个域名同时查询
ProjectId String 查询指定的项目下面的域名,不指定默认为全部
DomainStatus String 按域名状态过滤,默认为空,为空时代表当前用户下所有域名的全部状态,具体枚举类型表见使用须知
CdnType String 产品类型:file:大文件下载,video:音视频点播,page:小文件下载,live:流媒体直播,多个产品类型之间用逗号(半角)间隔,默认为空,代表当前用户下全部产品类型
FuzzyMatch String 域名过滤是否使用模糊匹配,取值为on:开启,off:关闭,默认为on

返回参数

参数名 类型及范围 说明
PageNumber Long 页码
PageSize Long 单页大小
TotalCount Long 总条数
Domains Domain[] Domain列表

Domain

参数名 类型及范围 说明
DomainName String 加速域名名称
DomainId String 域名ID
Cname String 加速域名对应的CNAME域名
CdnType String 产品类型:file:大文件下载,video:音视频点播,page:图片小文件,live:流媒体直播
CdnSubType String 加速业务产品子类型,若创建加速域名时未设置此项参数,则此处返回参数不显示此项,目前作为已废弃的历史遗留字段
IcpRegistration String ICP备案号
DomainStatus String 加速域名状态,具体枚举类型表见使用须知
CreatedTime String 加速域名创建时间
ModifiedTime String 加速域名最近修改时间
Description String 审核失败原因,正常情况下为空

示例

请求示例

GET方式:

GET /2016-09-01/domain/GetCdnDomains?PageSize=20&PageNumber=1&DomainName=&DomainStatus=online&CdnType&FuzzyMatch=on 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetCdnDomains
x-version: 2016-09-01

POST方式:

POST /2016-09-01/domain/GetCdnDomains 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetCdnDomains
x-version: 2016-09-01
Content-Type: application/x-www-form-urlencoded

PageSize=20&PageNumber=1&DomainName=&DomainStatus=online&CdnType&FuzzyMatch=on

返回示例

{
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 4,
  "Domains": [
    {
      "Description": "",
      "ModifiedTime": "2016-09-21T15:37+0800",
      "CreatedTime": "2016-09-21T15:37+0800",
      "IcpRegistration": "鄂ICP备15011961号-1",
      "DomainId": "2D09RCM",
      "CdnType": "live",
      "Cname": "www.test.com.hdlvcloud.ks-cdn.com",
      "CdnSubType": "video",
      "DomainName": "www.test.com",
      "DomainStatus": "online"
    },
    {
      "Description": "",
      "ModifiedTime": "2016-09-19T19:34+0800",
      "CreatedTime": "2016-09-19T19:34+0800",
      "IcpRegistration": "京ICP证030173号-1",
      "DomainId": "2D09RDG",
      "CdnType": "live",
      "Cname": "test2.com.hlsvcloud.ks-cdn.com",
      "CdnSubType": "video",
      "DomainName": "test2.com", 
     "DomainStatus": "online"
    },
    {
      "Description": "",
      "ModifiedTime": "2016-09-19T19:34+0800",
      "CreatedTime": "2016-09-19T19:34+0800",
      "IcpRegistration": "京ICP证030173号-1",
      "DomainId": "2D09RDG",
      "CdnType": "live",
      "Cname": "test3.com.hlsvcloud.ks-cdn.com",  
      "CdnSubType": "video",
      "DomainName": "test3.com", 
     "DomainStatus": "online"
    },
    {
      "Description": "",
      "ModifiedTime": "2016-09-19T17:49+0800",
      "CreatedTime": "2016-09-19T17:49+0800",
      "IcpRegistration": "粤B2-20090191-2",
      "DomainId": "2D09RDK",
      "CdnType": "live",
      "Cname": "www.test4.com.hlsvcloud.ks-cdn.com",
      "CdnSubType": "video",
      "DomainName": "www.test4.com", 
     "DomainStatus": "online"
    }
  ]
}

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

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

问题反馈