QueryDomainByParam - Direct Mail - Alibaba Cloud Documentation Center

Query domain information

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

dm:QueryDomainByParam

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	Current page number. Default: 1	1
PageSize	integer	No	Number of items per page, default: 10	10
KeyWord	string	No	Domain name, length 1-50, can include numbers, uppercase and lowercase letters, ., -.	example.com
Status	integer	No	0 indicates normal 1 indicates abnormal	0

Response elements

Element	Type	Description	Example
	object
PageSize	integer	Page size	50
RequestId	string	Request ID	8C90CCD3-627C-4F87-AD8C-2F03146071EB
PageNumber	integer	Current page number	1
TotalCount	integer	Total count	2
data	object
domain	array<object>	List of domains
	object
DomainRecord	string	Domain record	6bd86901b9fe4618a046
SpfAuthStatus	string	SPF authentication status, success: 0, failure: 1.	0
MxAuthStatus	string	MX authentication status, success: 0, failure: 1.	0
CreateTime	string	Creation time	2019-09-29T13:28Z
CnameAuthStatus	string	Track verification	0
ConfirmStatus	string	CName verification status, success: 0; failure: 1	0
IcpStatus	string	ICP filing status. 1 indicates filed 0 indicates not filed	1
UtcCreateTime	integer	Creation time in UTC format.	1569734892
DomainStatus	string	Domain status. 0: Available, verified 1: Unavailable, verification failed	0
DomainName	string	Domain name	example.com
DomainId	string	Domain ID	158923

Examples

Success response

JSON format

{
  "PageSize": 50,
  "RequestId": "8C90CCD3-627C-4F87-AD8C-2F03146071EB",
  "PageNumber": 1,
  "TotalCount": 2,
  "data": {
    "domain": [
      {
        "DomainRecord": "6bd86901b9fe4618a046",
        "SpfAuthStatus": "0",
        "MxAuthStatus": "0",
        "CreateTime": "2019-09-29T13:28Z",
        "CnameAuthStatus": "0",
        "ConfirmStatus": "0",
        "IcpStatus": "1",
        "UtcCreateTime": 1569734892,
        "DomainStatus": "0",
        "DomainName": "example.com",
        "DomainId": "158923"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.