Revokes the registration information of an Agent.
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 that is unique across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. Note
If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request. |
eyJhbGciOiJIUzI1NiIsInR5cC..... |
| AgentRegisterInfoId |
string |
Yes |
The Agent registration ID. This ID is automatically generated by the Alibaba Cloud ATS platform and is globally unique within the platform. It is automatically generated during the Agent registration process. This ID must be included throughout the API registration and query processes. Call the ListAtiAgentRegisterInfos operation to query the target Agent and obtain the AgentRegisterInfoId from the response. |
2074753647748672512 |
| Reason |
string |
No |
The reason for unregistration. Valid values:
|
Affiliation changed |
| ReasonCode |
string |
Yes |
The revocation reason code as defined in RFC 5280. Valid values:
|
unspecified |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The unique request ID. |
6856BCF6-11D6-4D7E-AC53-FD579933522B |
| Success |
boolean |
Indicates whether the request was successful. Valid values: |
true |
| AccessDeniedDetail |
object |
The details about the access denial. This field is returned only when RAM authentication fails. |
|
| AuthAction |
string |
The unauthorized operation that was attempted. |
RemoveRspDomainServerHoldStatusForGatewayOte |
| 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 |
Examples
Success response
JSON format
{
"RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
"Success": true,
"AccessDeniedDetail": {
"AuthAction": "RemoveRspDomainServerHoldStatusForGatewayOte",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.