QueryRegistrantProfiles - - Alibaba Cloud Documentation Center

Queries the registrant profiles that belong to your Alibaba Cloud account.

Operation description

You can use optional request parameters to specify specific query criteria to query registrant profiles as required. For example:

If you know the ID of the profile that you want to query, you can use the registrant profile ID parameter to query the detailed information about the profile.
If you do not know the ID of the profile that you want to query, you can use parameters such as the registrant name parameter to query the detailed information about the profile.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
domain:QueryRegistrantProfile	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the error message to return if the request fails. Valid values: zh: Chinese en: English Default value: en.	en
RegistrantOrganization	string	No	The name of the domain name registrant.	li si
UserClientIp	string	No	The IP address of the client. Set the value to 127.0.0.1.	127.0.0.1
RegistrantProfileId	long	No	The ID of the registrant profile that you want to query. The system generates an ID after you create a registrant profile.	1234567
DefaultRegistrantProfile	boolean	No	Specifies whether to query the default profile. Valid values: true false Default value: false.	false
PageNum	integer	No	The number of the page to return. Default value: 0.	1
PageSize	integer	No	The number of entries per page. Default value: 0. Maximum value: 5000.	500
ZhRegistrantOrganization	string	No	The Chinese name of the domain name registrant.
RegistrantType	string	No	The type of the domain name registrant. Valid values: 1: individual. 2: enterprise. Default value: 1.	1
RealNameStatus	string	No	The state of real-name verification for the domain name registrant. Valid values: FAILED: Real-name verification for the domain name fails. SUCCEED: Real-name verification for the domain name is successful. NONAUDIT: Real-name verification for the domain name is not performed. AUDITING: Real-name verification for the domain name is in progress.	SUCCEED
Email	string	No	The email address of the domain name registrant.	username@example.com
RegistrantProfileType	string	No	The type of the registrant profile. Valid values: common: common profile. cnnic: China Internet Network Information Center (CNNIC) profile. Note Only the Alibaba Cloud international site (alibabacloud.com) supports CNNIC profiles. To register domain names provided by CNNIC such as the .cn and . domain names on the Alibaba Cloud international site, you must use a CNNIC profile. To register other domain names, use a common profile.	common
Remark	string	No	The remarks.	Test domain name

Response parameters

Parameter	Type	Description	Example
	object
NextPage	boolean	Indicates whether the current page is followed by a page. Valid values: true false	true
RequestId	string	The request ID.	94053D79-7455-4F71-BF06-20EB2DEDE6BD
TotalItemNum	integer	The total number of entries. Note This parameter indicates the total number of queried registrant profiles. If multiple registrant profiles are queried, the information about these profiles is returned in sequence by profile.	9
PrePage	boolean	Indicates whether the current page is preceded by a page. Valid values: true false	false
CurrentPageNum	integer	The page number returned.	1
TotalPageNum	integer	The total number of returned pages.	1
PageSize	integer	The number of entries returned on each page. Default value: 0. Maximum value: 5000.	2
RegistrantProfiles	array<object>	The list of registrant profiles.
RegistrantProfile	object
TelExt	string	The extension of the phone number.	1234
UpdateTime	string	The time when the registrant profile was updated.	2019-03-15 15:32:45
ZhProvince	string	The province where the domain name registrant is located, in Chinese.
CreateTime	string	The time when the registrant profile was created.	2019-02-18 10:46:47
Telephone	string	The phone number.	1829756****
RegistrantOrganization	string	The name of the domain name registrant.	li si
City	string	The city where the domain name registrant is located, in English.	hang zhou shi
ZhCity	string	The city where the domain name registrant is located, in Chinese.
TelArea	string	The international dialing code of the country or region where the domain name contact is located. For example, the international dialing code of China is 86.	86
Address	string	The address of the domain name registrant.	zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao
RealNameStatus	string	The state of real-name verification for the domain name registrant. Valid values: FAILED: Real-name verification for the domain name fails. SUCCEED: Real-name verification for the domain name is successful. NONAUDIT: Real-name verification for the domain name is not performed. AUDITING: Real-name verification for the domain name is in progress.	SUCCEED
PostalCode	string	The postal code of the region where the domain name registrant is located.	310024
RegistrantProfileType	string	The type of the registrant profile. Valid values: common: common profile. cnnic: CNNIC profile. Note Only the Alibaba Cloud international site (alibabacloud.com) supports CNNIC profiles. To register domain names provided by CNNIC such as the .cn and . domain names on the Alibaba Cloud international site, you must use a CNNIC profile. To register other domain names, use a common profile.	common
RegistrantProfileId	long	The ID of the registrant profile.	1000001
ZhRegistrantOrganization	string	The Chinese name of the domain name registrant.
DefaultRegistrantProfile	boolean	Indicates whether the template is the default template. Valid values: true false Default value: false.	false
Email	string	The email address of the domain name registrant.	82106****@qq.com
ZhRegistrantName	string	The Chinese name of the domain name contact.
RegistrantType	string	The type of the domain name registrant. Valid values: 1: individual. 2: enterprise. Default value: 1.	1
Country	string	The code of the country or region where the domain name registrant is located, such as CN or US.	CN
RegistrantName	string	The name of the domain name contact.	li si
EmailVerificationStatus	integer	The status of the verification for the email address. Valid values: 0: not verified 1: verified	1
ZhAddress	string	The address of the domain name registrant, in Chinese.
Province	string	The province where the domain name registrant is located.	zhe jiang
CredentialNo	string	The certificate number.	4****************1
CredentialType	string	The certificate type.	YYZZ
Remark	string	The remarks.	Test domain name

Examples

Sample success responses

JSONformat

{
  "NextPage": true,
  "RequestId": "94053D79-7455-4F71-BF06-20EB2DEDE6BD",
  "TotalItemNum": 9,
  "PrePage": false,
  "CurrentPageNum": 1,
  "TotalPageNum": 1,
  "PageSize": 2,
  "RegistrantProfiles": {
    "RegistrantProfile": [
      {
        "TelExt": "1234",
        "UpdateTime": "2019-03-15 15:32:45",
        "ZhProvince": "",
        "CreateTime": "2019-02-18 10:46:47",
        "Telephone": "1829756****",
        "RegistrantOrganization": "li si",
        "City": "hang zhou shi",
        "ZhCity": "",
        "TelArea": "86",
        "Address": "zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao",
        "RealNameStatus": "SUCCEED",
        "PostalCode": "310024",
        "RegistrantProfileType": "common",
        "RegistrantProfileId": 1000001,
        "ZhRegistrantOrganization": "",
        "DefaultRegistrantProfile": false,
        "Email": "82106****@qq.com",
        "ZhRegistrantName": "",
        "RegistrantType": "1",
        "Country": "CN",
        "RegistrantName": "li si",
        "EmailVerificationStatus": 1,
        "ZhAddress": "",
        "Province": "zhe jiang",
        "CredentialNo": "4****************1",
        "CredentialType": "YYZZ",
        "Remark": "Test domain name\n"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-25	The request parameters of the API has changed. The response structure of the API has changed	View Change Details