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	产品类型：wcdn，对应全站加速。默认为空，代表当前用户泛cdn下全部产品类型（含非wcdn的类型）
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	产品类型：wcdn，对应全站加速。默认为空，代表当前用户泛cdn下全部产品类型（含非wcdn的类型）
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=wcdn-&DomainStatus=online&CdnType=wcdn&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/json

{
    "PageSize": 20,
    "PageNumber": 1,
    "DomainName": "wcdn-",
    "DomainStatus": "online",
    "CdnType": "wcdn",
    "FuzzyMatch": "on"
}

返回示例

{
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 3,
    "Domains": [
        {
            "DomainName": "wcdn-20220304-1.ksc-test.com",
            "DomainId": "2D07ANU",
            "Cname": "wcdn-20220304-1.ksc-test.com.download.ks-cdn.com",
            "CdnType": "wcdn",
            "CdnSubType": "wcdn",
            "IcpRegistration": "京ICP备12032080号-12",
            "DomainStatus": "online",
            "CreatedTime": "2022-03-04T15:01+0800",
            "ModifiedTime": "2022-03-07T17:32+0800",
            "Description": "",
            "ProjectId": 0,
            "ProjectName": "默认项目"
        },
        {
            "DomainName": "zhu-wcdn-test.ksc-test.com",
            "DomainId": "2D07SSS",
            "Cname": "zhu-wcdn-test.ksc-test.com.download.ks-cdn.com",
            "CdnType": "wcdn",
            "CdnSubType": "wcdn",
            "IcpRegistration": "京ICP备12032080号-12",
            "DomainStatus": "online",
            "CreatedTime": "2021-07-08T19:03+0800",
            "ModifiedTime": "2021-09-23T13:28+0800",
            "Description": "",
            "ProjectId": 0,
            "ProjectName": "默认项目"
        },
        {
            "DomainName": "wcdn-test3.ksc-test.com",
            "DomainId": "2D07U2P",
            "Cname": "wcdn-test3.ksc-test.com.download.ks-cdn.com",
            "CdnType": "wcdn",
            "CdnSubType": "wcdn",
            "IcpRegistration": "京ICP备12032080号-12",
            "DomainStatus": "online",
            "CreatedTime": "2021-06-11T11:22+0800",
            "ModifiedTime": "2021-10-18T14:06+0800",
            "Description": "",
            "ProjectId": 0,
            "ProjectName": "默认项目"
        }
    ]
}

错误码

为了帮您快速定位问题，WCDN将错误码集中归类，请到【使用须知】查看详情。