All Products
Search
Document Center

Direct Mail:QueryDomainByParam

Last Updated:Jul 21, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query domain information

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
dm:QueryDomainByParamget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNointegerNo

Current page number. Default: 1

1
PageSizeintegerNo

Number of items per page, default: 10

10
KeyWordstringNo

Domain name, length 1-50, can include numbers, uppercase and lowercase letters, ., -.

example.com
StatusintegerNo
  • 0 indicates normal
  • 1 indicates abnormal
0

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

Page size

50
RequestIdstring

Request ID

8C90CCD3-627C-4F87-AD8C-2F03146071EB
PageNumberinteger

Current page number

1
TotalCountinteger

Total count

2
dataarray<object>

List of domains

domainobject
DomainRecordstring

Domain record

6bd86901b9fe4618a046
SpfAuthStatusstring

SPF authentication status, success: 0, failure: 1.

0
MxAuthStatusstring

MX authentication status, success: 0, failure: 1.

0
CreateTimestring

Creation time

2019-09-29T13:28Z
CnameAuthStatusstring

Track verification

0
ConfirmStatusstring

CName verification status, success: 0; failure: 1

0
IcpStatusstring

ICP filing status.

  • 1 indicates filed
  • 0 indicates not filed
1
UtcCreateTimelong

Creation time in UTC format.

1569734892
DomainStatusstring

Domain status.

  • 0: Available, verified
  • 1: Unavailable, verification failed
0
DomainNamestring

Domain name

example.com
DomainIdstring

Domain ID

158923

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2022-09-05API Description Update. The Error code has changedView Change Details