All Products
Search
Document Center

DescribeDcdnUserDomains

Last Updated: Mar 01, 2019

Description

You can call this operation to obtain all DCDN domain names in your account. Domain name fuzzy matching and domain name status filtering are supported.

The status of a domain name can be:

  • Running
  • Stopped
  • Configuring
  • Configuration failed
  • Under review
  • Not Approved
  • Request parameters

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeDcdnUserDomains.
PageSize Long No The number of items displayed on the page. Default value: 20. Valid values: any integer from 1 to 50.
PageNumber Long No The page number. Valid values: 1-100000.
DomainName String No The domain name, used as a condition of fuzzy matching and filtering.
DomainSearchType String No The search method. Valid values: fuzzy_match, pre_match, suf_match, and full_match.
  • fuzzy_match: fuzzy match.
  • pre_match: prefix match.
  • suf_match: suffix match.
  • full_match: exact match.
Default value: fuzzy_match.
DomainStatus String No The domain name status, used as a filtering condition.
ResourceGroupId String No The ID of the resource group.
FuncFilter String No The filtering of features. Valid values: config and unconfig. config: a feature with a funcid. unconfig: a feature without a funcid.
FuncId String No The ID of the feature. For example, you can set the ID for a feature to porn image detection.

Response parameters

Name Type Description
RequestId String The ID of the request.
PageNumber Long The page number.
PageSize Long The number of items displayed on the page.
TotalCount Long The total number of items found.
Domains PageData[] The details about the DCDN domain name status.
OnlineCount Long The total number of online domain names.

PageData

Name Type Description
DomainName String The DCDN domain name.
Cname String The CNAME for the DCDN domain name.
DomainStatus String The status of the DCDN domain names. Valid values: online, offline, configuring, configure_failed, checking, and check_failed.
  • online: The domain name is enabled.
  • offline: The domain name is disabled.
  • configuring: The domain name is being configured.
  • configure_failed: The domain name configuration has failed.
  • checking: The domain name is under review.
  • check_failed: The domain name has failed the review.
GmtCreated String The time at which the domain name was created.
GmtModified String The time at which the domain name was last modified.
Description String The cause why the review failed.
ResourceGroupId String The ID of the resource group.
SSLProtocol String Indicates whether the HTTPS protocol is enabled. Valid values: on and off.
  • on: The HTTPS protocol is enabled.
  • off: The HTTPS protocol is disabled.
Sources Source[] The details about the origin.

Source

Name Type Description
Type String The type of the origin.
Content String The URL of the origin.
Port Integer The port of the origin.
Priority String The priority of the origin when multiple origins exist.

Examples

Sample requests

  1. https://dcdn.aliyuncs.com?&Action=DescribeDcdnUserDomains&PageNumber=1&PageSize=5&DomainSearchType=fuzzy_match&<Common request parameters>

Sample responses

JSON format

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 16,
  4. "OnlineCount": 10,
  5. "PageSize": 5,
  6. "RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
  7. "Domains": {
  8. "PageData": [
  9. {
  10. "DomainStatus": "configure_failed",
  11. "DomainName": "image.ddd.cdnpe.com",
  12. "GmtModified": "2015-10-28T11:05:52Z",
  13. "GmtCreated": "2015-10-28T09:32:51Z",
  14. "Description": "audit failed",
  15. "ResourceGroupId":"abcd1234abcd1234"
  16. },
  17. {
  18. "DomainStatus": "configure_failed",
  19. "DomainName": "aadda.cdnpe.com",
  20. "GmtModified": "2015-10-28T11:05:50Z",
  21. "GmtCreated": "2015-10-28T09:31:59Z",
  22. "ResourceGroupId":"abcd1234abcd1234"
  23. },
  24. {
  25. "Cname": "onlytest.cdnpe.com.w.alikunlun.net",
  26. "DomainStatus": "online",
  27. "DomainName": "onlytest.cdnpe.com",
  28. "GmtModified": "2015-10-27T06:26:34Z",
  29. "GmtCreated": "2015-10-23T09:30:00Z",
  30. "ResourceGroupId":"abcd1234abcd1234"
  31. },
  32. {
  33. "Cname": "test11.cdnpe.com.w.kunlunAr.com",
  34. "DomainStatus": "online",
  35. "DomainName": "test11.cdnpe.com",
  36. "GmtModified": "2015-10-23T09:23:29Z",
  37. "GmtCreated": "2015-10-23T09:23:20Z",
  38. "ResourceGroupId":"abcd1234abcd1234"
  39. },
  40. {
  41. "Cname": "test.aliyun.com.w.alikunlun.com",
  42. "DomainStatus": "online",
  43. "DomainName": "test.aliyun.com",
  44. "GmtModified": "2015-10-23T09:02:11Z",
  45. "GmtCreated": "2015-10-23T09:01:57Z",
  46. "ResourceGroupId":"abcd1234abcd1234"
  47. }
  48. ]
  49. }
  50. }

Error codes

Error code Error message HTTP status code Description
InvalidPageNumber.ValueNotSupported The specified value of parameter PageNumber is not supported. 400 The error message returned when the specified PageNumber value is invalid.
InvalidPageSize.ValueNotSupported The specified value of parameter PageSize is not supported. 400 The error message returned when the specified PageSize value is invalid.
InvalidDomainName.Malformed The specific value of parameter DomainName is malformed. 400 The error message returned when the specified DomainName value is invalid.
InvalidDomainStatus.ValueNotSupported The specified value of parameter DomainStatus is not supported. 400 The error message returned when the specified DomainStatus value is invalid.
InvalidDomainSearchType.ValueNotSupported The specified value of parameter DomainSearchType is not supported. 400 The error message returned when the specified DomainSearchType value is invalid.