DescribeUserDomains - API Reference| Alibaba Cloud Documentation Center

Description

Query all the domain names and statuses under a user name. Support domain name fuzzy match filtering and domain name status filtering. The domain name status includes:

running (indicates the domain name service is normal and can be used)
stopped
configuring
configure_failed
Checking
Checking_failed

Request parameters

Parameters	Type	Required	Example values	Description
Action	String	Yes	DescribeUserDomains	The name of this interface. Value: DescribeUserDomains
CdnType	String	No	web	CDN business type, separated by comma.
CheckDomainShow	Boolean	No	true	Whether the domain name at the checking status is shown.
DomainName	String	No	www.yourdomain.com	Domain name fuzzy match filtering.
DomainSearchType	String	No	fuzzy_match	Domain name search type: fuzzy_match: fuzzy match pre_match: pre-match suf_match: suf-match full_match: fully match Default value: fuzzy_match
DomainStatus	String	No	online	The domain name status filtering.
FuncFilter	String	No	config	Filtering, supports config and unconfig. config indicates funcid is activated, and unconfig indicates the funcid is not activated.
FuncId	String	No	98	funcid, such as the picture porn-detection function 98.
PageNumber	Integer	No	1	The page number. Range value: 1~100000
PageSize	Integer	No	20	The page size. Range value: random integer between 1 and 50. /br>Maximum: 50 Default value: 20
ResourceGroupId	String	No	your resourceGroupId	Resource group ID.
Sources	String	No	a.b.com	Search according to the source address.

Return parameters

Parameters	Type	Example values	Description
RequestId	String	AA75AADB-5E25-4970-B480-EAA1F5658483	The request ID.
PageNumber	Long	1	The page number of the return data.
PageSize	Long	5	The size of the whole page.
TotalCount	Long	16	The total number.
Domains			The domain list information.
└DomainName	String	onlytest.cdnpe.com	The ame of the CDN domain name.
└Cname	String	onlytest.cdnpe.com.w.alikunlun.net	The CNAME corresponding to the CDN domain name.
└CdnType	String	video	Acceleration business type. Value range: web: acceleration of images and small files download: acceleration of large file downloads video: acceleration of audio and video on demand livestream: acceleration of live streaming media httpsdelivery: HTTPS security acceleration
└DomainStatus	String	online	CDN domain name status. Value: online: activating offline: deactivating configuring: configuring configure_failed: configuration failed checking: checking check_failed: checking failed
└GmtCreated	String	2015-10-28T09:31:59Z	The creation time of CDN domain name.
└GmtModified	String	2015-10-28T11:05:50Z	The modification time of CDN domain name.
└Description	String	audit failed	The reason of checking failure.
└ResourceGroupId	String	abcd1234abcd1234	The resource group ID.
└SourceType	String	oss	The source site type.
└SslProtocol	String	on	Switch.
└Sandbox	String		Sandbox.
└Sources	String	{ “Source”: [ “a.b.com” ] }	Source site information.

Example

Request example

https://cdn.aliyuncs.com?&Action=DescribeUserDomains&PageNumber=1&PageSize=5&DomainSearchType=fuzzy_match&<Public request parameter>

Normal return example

JSON format

{
    "Domains":{
        "PageData":[
            {
                "CdnType":"download",
                "Description":"audit failed",
                "DomainName":"image.ddd.cdnpe.com",
                "DomainStatus":"configure_failed",
                "GmtCreated":"2015-10-28T09:32:51Z",
                "GmtModified":"2015-10-28T11:05:52Z",
                "ResourceGroupId":"abcd1234abcd1234"
            },
            {
                "CdnType":"web",
                "DomainName":"aadda.cdnpe.com",
                "DomainStatus":"configure_failed",
                "GmtCreated":"2015-10-28T09:31:59Z",
                "GmtModified":"2015-10-28T11:05:50Z",
                "ResourceGroupId":"abcd1234abcd1234"
            },
            {
                "CdnType":"video",
                "Cname":"onlytest.cdnpe.com.w.alikunlun.net",
                "DomainName":"onlytest.cdnpe.com",
                "DomainStatus":"online",
                "GmtCreated":"2015-10-23T09:30:00Z",
                "GmtModified":"2015-10-27T06:26:34Z",
                "ResourceGroupId":"abcd1234abcd1234"
            },
            {
                "CdnType":"video",
                "Cname":"test11.cdnpe.com.w.kunlunAr.com",
                "DomainName":"test11.cdnpe.com",
                "DomainStatus":"online",
                "GmtCreated":"2015-10-23T09:23:20Z",
                "GmtModified":"2015-10-23T09:23:29Z",
                "ResourceGroupId":"abcd1234abcd1234"
            },
            {
                "CdnType":"video",
                "Cname":"test.aliyun.com.w.alikunlun.com",
                "DomainName":"test.aliyun.com",
                "DomainStatus":"online",
                "GmtCreated":"2015-10-23T09:01:57Z",
                "GmtModified":"2015-10-23T09:02:11Z",
                "ResourceGroupId":"abcd1234abcd1234"
            }
        ]
    },
    "PageNumber":1,
    "PageSize":5,
    "RequestId":"AA75AADB-5E25-4970-B480-EAA1F5658483",
    "TotalCount":16
}

Exception return example

JSON format

{
    "Code":"InternalError",
    "HostId":"cdn.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error code

For more information, see Error code of this product.