Call QueryDomainByParam to query information about a list of domains -

You can call the QueryDomainByParam operation to query information about a list of domains.

Debug

You can call this operation directly in OpenAPI Explorer without having to calculate signatures. After a successful call, OpenAPI Explorer automatically generates sample code for the software development kit (SDK).

Request parameters

Name	Type	Required	Example value	Description
Action	String	No	QueryDomainByParam	The name of the API operation. Set the value to `QueryDomainByParam`.
KeyWord	String	No	example.com	The domain name. The domain name must be 1 to 50 characters in length and can contain digits, uppercase letters, lowercase letters, periods (.), and hyphens (-).
PageNo	Integer	No	1	The page number. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Default value: 10.
Status	Integer	No	0	0: Normal 1: Abnormal

Response parameters

Name	Type	Example value	Description
PageNumber	Integer	1	The page number.
TotalCount	Integer	2	The total number of entries.
PageSize	Integer	50	The number of entries per page.
RequestId	String	8C90CCD3-627C-4F87-AD8C-2F03146071EB	The request ID.
data	Array	{xx}	The data records.

data

Name	Type	Example value	Description
domain	List	[xx]	The data records.

domain

Name	Type	Example value	Description
CnameAuthStatus	String	0	The track record authentication status.
ConfirmStatus	String	0	The CNAME authentication flag. 0: Success. 1: Failed.
CreateTime	String	2019-09-29T13:28Z	The time when the domain name was created.
DomainId	String	158923	The domain ID.
DomainName	String	aliyundoc.com	The domain name.
DomainStatus	String	0	The status of the domain name. 0: The domain name is active and verified. 1: The domain name is inactive and not verified.
IcpStatus	String	1	The ICP filing status. 1: The domain name has an ICP filing. 0: The domain name does not have an ICP filing.
MxAuthStatus	String	0	The MX record authentication flag. 0: Success. 1: Failed.
SpfAuthStatus	String	0	The SPF record authentication flag. 0: Success. 1: Failed.
UtcCreateTime	Long	1569734892	The time when the domain name was created. The time is in UTC.
DomainRecord	String	6bd86901b9fe4618a046	The TXT record value for domain ownership verification.

Examples

Sample request

http(s)://[Endpoint]/?Action=QueryDomainByParam
&<Common request parameters>

Sample response

JSON format

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

Error codes

For more information about error codes, see the Error Center.