Query Registrant Profiles with QueryRegistrantProfiles API - Alibaba Cloud Domains - Alibaba Cloud -

Call the QueryRegistrantProfiles API to query the domain information templates in your account.

Operation description

You can use optional parameters to refine your search for information templates. For example:

If you know the information template ID, you can provide it to retrieve its details.
If you do not know the information template ID, you can provide other parameters, such as the registrant name, to retrieve template details.

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

domain:QueryRegistrantProfile

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of error messages. Valid values: zh: Chinese. en: English. The default value is en.	en
RegistrantOrganization	string	No	The English name of the registrant organization.	li si
UserClientIp	string	No	The user's client IP address. You can set this to 127.0.0.1.	127.0.0.1
RegistrantProfileId	integer	No	The ID of the registrant profile. The system automatically generates this ID after the registrant profile is created.	1234567
DefaultRegistrantProfile	boolean	No	Specifies if the profile is the default registrant profile. Valid values: true: The profile is the default registrant profile. false: The profile is not the default registrant profile. The default value is false.	false
PageNum	integer	No	The page number. Pages start from 1, and the default value is 1.	1
PageSize	integer	No	The number of entries per page. The maximum value is 5000.	500
ZhRegistrantOrganization	string	No	The Chinese name of the registrant organization.	李四
RegistrantType	string	No	The type of the registrant. Valid values: 1: Individual 2: Enterprise The default value is 1.	1
RealNameStatus	string	No	The real-name verification status. Valid values: FAILED: The real-name verification failed. SUCCEED: The real-name verification is successful. NONAUDIT: The real-name verification has not been performed. AUDITING: The real-name verification is in progress.	SUCCEED
Email	string	No	The registrant's email address.	username@example.com
RegistrantProfileType	string	No	The registrant profile type. Valid values: common: A common template. cnnic: A CNNIC template. Note The cnnic template is supported only on the Alibaba Cloud International site and must be used for domains registered on this site that are managed by the CNNIC registry, such as '.cn' and '.中国'. Use the general template for all other domains.	common
Remark	string	No	A remark for the registrant profile.	测试域名

Response elements

Element	Type	Description	Example
	object
NextPage	boolean	Indicates whether a next page of results is available. Valid values: true: A next page is available. false: This is the last page.	true
RequestId	string	The request ID.	94053D79-7455-4F71-BF06-20EB2DEDE6BD
TotalItemNum	integer	The total number of entries. Note This value indicates the total number of registrant profiles that are returned. If a large number of registrant profiles are returned, the entries are displayed on multiple pages.	9
PrePage	boolean	Indicates whether a previous page of results is available. Valid values: true: A previous page is available. false: This is the first page.	false
CurrentPageNum	integer	The current page number.	1
TotalPageNum	integer	The total number of pages.	1
PageSize	integer	The number of entries per page. Default value: 0. Maximum value: 5000.	2
RegistrantProfiles	object
RegistrantProfile	array<object>	The list of registrant profiles.
	object
TelExt	string	The telephone extension.	1234
UpdateTime	string	The time when the registrant profile was last updated.	2019-03-15 15:32:45
ZhProvince	string	The name of the province in Chinese.	浙江
CreateTime	string	The time when the registrant profile was created.	2019-02-18 10:46:47
Telephone	string	The telephone number.	1829756****
RegistrantOrganization	string	The name of the registrant organization in English.	li si
City	string	The name of the city in English.	hang zhou shi
ZhCity	string	The name of the city in Chinese.	杭州市
TelArea	string	The country calling code. For example, the country calling code of China is 86.	86
Address	string	The address in English.	zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao
RealNameStatus	string	The real-name verification status. Valid values: FAILED: The real-name verification failed. SUCCEED: The real-name verification was successful. NONAUDIT: The real-name verification is not performed. AUDITING: The real-name verification is in progress.	SUCCEED
PostalCode	string	The postal code.	310024
RegistrantProfileType	string	The type of the registrant profile. Valid values: common: a common registrant profile. cnnic: a CNNIC registrant profile. Note The CNNIC template is supported only on the Alibaba Cloud International site. You must use this template for domain names, such as .cn and .中国, that are registered on the site and managed by the CNNIC registry. Use the general template for all other domain names.	common
RegistrantProfileId	integer	The ID of the registrant profile.	1000001
ZhRegistrantOrganization	string	The name of the registrant organization in Chinese.	李四
DefaultRegistrantProfile	boolean	Indicates whether the registrant profile is the default one. Valid values: true false Default value: false.	false
Email	string	The email address.	82106****@qq.com
ZhRegistrantName	string	The name of the contact in Chinese.	李四
RegistrantType	string	The type of the registrant. Valid values: 1: an individual. 2: an enterprise. Default value: 1.	1
Country	string	The country code. For example, CN indicates China, and US indicates the United States.	CN
RegistrantName	string	The name of the contact in English.	li si
EmailVerificationStatus	integer	The verification status of the email address. Valid values: 0: The email address is not verified. 1: The email address is verified.	1
ZhAddress	string	The address in Chinese.	浙江省杭州市示例区示例镇示例大厦1001号
Province	string	The name of the province in English.	zhe jiang
CredentialNo	string	The credential number.	4****************1
CredentialType	string	The credential type.	YYZZ
Remark	string	The remarks.	测试域名
Params	string

Examples

Success response

JSON format

{
  "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": "浙江省杭州市示例区示例镇示例大厦1001号",
        "Province": "zhe jiang",
        "CredentialNo": "4****************1",
        "CredentialType": "YYZZ",
        "Remark": "测试域名",
        "Params": ""
      }
    ]
  }
}

Error response

JSON format

{
  "CurrentPageNum": 1,
  "NextPage": true,
  "PageSize": 2,
  "PrePage": false,
  "RegistrantProfiles": {
    "RegistrantProfile": [
      {
        "Address": "aqqqq",
        "City": "us",
        "Country": "US",
        "CreateTime": "Dec 25,2017 03:20:30",
        "DefaultRegistrantProfile": true,
        "Email": "a@xxx.com",
        "EmailVerificationStatus": 0,
        "PostalCode": "010101",
        "Province": "qa",
        "RegistrantName": "x",
        "RegistrantOrganization": "xxx",
        "RegistrantProfileId": 5170612,
        "TelArea": "010",
        "Telephone": "11119999",
        "UpdateTime": "Dec 25,2017 03:21:59"
      },
      {
        "Address": "xx District",
        "City": "Beijing",
        "Country": "MO",
        "CreateTime": "Nov 22,2017 09:20:40",
        "DefaultRegistrantProfile": false,
        "Email": "abctest@xxx.com",
        "EmailVerificationStatus": 0,
        "PostalCode": "100086",
        "Province": "Beijing",
        "RegistrantName": "lk",
        "RegistrantOrganization": "lk",
        "RegistrantProfileId": 5049715,
        "TelArea": "853",
        "Telephone": "15600000000",
        "UpdateTime": "Nov 22,2017 09:20:40"
      }
    ]
  },
  "RequestId": "8843D641-7520-4399-9FCC-BFB90C068E6F",
  "TotalItemNum": 11,
  "TotalPageNum": 6
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.