All Products
Search
Document Center

Security Center:DescribeDomainList

Last Updated:Nov 25, 2024

Queries the information about the domain assets within your Alibaba Cloud account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeDomainListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

192.122.XX.XX
FuzzyDomainstringNo

The keyword that is used to query domain names. Fuzzy match is supported.

sas
DomainTypestringNo

The type of the domain name that you want to query. Valid values:

  • root: root domain name
  • sub: subdomain name
root
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

0B48AB3C-84FC-424D-A01D-B9270EF46038
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

10
PageSizeinteger

The number of entries returned per page. Default value: 10.

10
TotalCountinteger

The total number of entries returned.

27
Countinteger

The number of entries returned on the current page.

10
DomainListResponseListarray<object>

An array that consists of the information about domain names.

DomainResponseobject
IpListstring

The IP addresses of the domain name.

1.2.XX.XX,1.0.XX.XX
Domainstring

The name of the domain or website.

example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF46038",
  "PageInfo": {
    "CurrentPage": 10,
    "PageSize": 10,
    "TotalCount": 27,
    "Count": 10
  },
  "DomainListResponseList": [
    {
      "IpList": "1.2.XX.XX,1.0.XX.XX",
      "Domain": "example.com"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-12-23API Description Update. The API operation is not deprecated.View Change Details