DescribeDomainList API Reference for Domain Asset Retrieval - Security Center - Alibaba Cloud - Security Center

Queries information about your domain name assets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeDomainList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	192.122.XX.XX
FuzzyDomain	string	No	The search keyword for the domain name to query. Fuzzy match is supported.	sas
DomainType	string	No	The type of the domain name to query. Valid values: root: root domain name sub: subdomain name.	root
PageSize	integer	No	The number of domain names to display on each page in a paged query. Default value: 10, which indicates that 10 domain names are displayed on each page.	10
CurrentPage	integer	No	The page number of the page to return in a paged query. Default value: 1, which indicates that the first page is returned.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. The ID is a unique identifier that Alibaba Cloud generates for the request and can be used to troubleshoot issues.	0B48AB3C-84FC-424D-A01D-B9270EF46038
PageInfo	object	The pagination information of the query result.
CurrentPage	integer	The page number of the current page in a paged query.	10
PageSize	integer	The number of domain names displayed on each page in a paged query. Default value: 10, which indicates that 10 domain names are displayed on each page.	10
TotalCount	integer	The total number of domain names returned.	27
Count	integer	The number of domain names displayed on the current page in a paged query.	10
DomainListResponseList	array<object>	The list of domain name asset information.
	object
IpList	string	The IP address information associated with the domain name.	1.2.XX.XX,1.0.XX.XX
Domain	string	The domain name or website name.	example.com

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.