Queries the list of real-name verified registrants.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
Ensures the idempotency of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length.
|
eyJhbGciOiJIUzI1NiIsInR5cC..... |
| PageSize |
integer |
Yes |
The number of rows per page in a paged query. Maximum value: 100. Default value: 20. |
2 |
| PageNumber |
integer |
Yes |
The current page number. Minimum value: 1. Default value: 1. |
1 |
| Name |
string |
No |
The name of the real-name verified registrant. |
John Doe |
| Status |
string |
No |
The real-name verification status. Valid values:
|
Approved |
| MaxResults |
integer |
No |
The maximum number of records to return in this request. |
500 |
| NextToken |
string |
No |
The token for the next query. |
4698691 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The unique request ID. |
B57C121B-A45F-44D8-A9B2-XXXXXXX |
| PageNumber |
integer |
The current page number. Minimum value: 1. Default value: 1. |
1 |
| PageSize |
integer |
The number of rows per page in a paged query. Maximum value: 100. Default value: 20. |
2 |
| TotalPages |
integer |
The total number of pages. |
11 |
| TotalItems |
integer |
The total number of records. |
224 |
| Registrants |
object |
||
| Registrant |
array<object> |
The registrant information. |
|
|
object |
|||
| Name |
string |
The name of the registrant. |
eop-antipiracy |
| RegistrantId |
string |
The ID of the real-name verified registrant. |
2072277378616354816 |
| DocumentType |
string |
The document type of the registrant. For more information, see the appendix on document types. |
ID_CARD |
| DocumentCode |
string |
The document number of the registrant. The value cannot exceed 50 characters in length. |
11011239900307663x |
|
string |
The email address of the registrant. |
example@example.com |
|
| State |
string |
The province or state. |
California |
| City |
string |
The city. |
Los Angeles |
| Status |
string |
The real-name verification status. Valid values:
|
Approved |
| CreateTimestamp |
string |
The creation time (timestamp). |
1783494791339 |
| UpdateTimestamp |
string |
The modification time (timestamp). |
1711953897000 |
| Cc |
string |
The country. |
CN |
| AccessDeniedDetail |
object |
The details of the access denial. This field is returned only when RAM authentication fails. |
|
| AuthAction |
string |
The unauthorized operation that was attempted. |
AddRspDomainServerHoldStatusForGatewayOte |
| AuthPrincipalDisplayName |
string |
The display name of the authorization principal. |
2015555733387XXXX |
| AuthPrincipalOwnerId |
string |
The owner ID of the authorization principal. |
10469733312XXX |
| AuthPrincipalType |
string |
The identity type. |
SubUser |
| EncodedDiagnosticMessage |
string |
The encrypted complete diagnostic message. |
AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng== |
| NoPermissionType |
string |
The reason for the authentication failure. Valid values:
|
ImplicitDeny |
| PolicyType |
string |
The policy type. |
DlpSend |
| MaxResults |
integer |
The maximum number of records to return in this request. |
500 |
| NextToken |
string |
The token for the next query. |
4698691 |
Examples
Success response
JSON format
{
"RequestId": "B57C121B-A45F-44D8-A9B2-XXXXXXX",
"PageNumber": 1,
"PageSize": 2,
"TotalPages": 11,
"TotalItems": 224,
"Registrants": {
"Registrant": [
{
"Name": "eop-antipiracy",
"RegistrantId": "2072277378616354816",
"DocumentType": "ID_CARD",
"DocumentCode": "11011239900307663x",
"Email": "example@example.com",
"State": "California.",
"City": "Los Angeles.",
"Status": "Approved.",
"CreateTimestamp": "1783494791339",
"UpdateTimestamp": "1711953897000",
"Cc": "CN"
}
]
},
"AccessDeniedDetail": {
"AuthAction": "AddRspDomainServerHoldStatusForGatewayOte",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
},
"MaxResults": 500,
"NextToken": "4698691"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.