All Products
Search
Document Center

Alibaba Cloud DNS:RevokeAtiAgentRegisterInfo

Last Updated:Aug 28, 2026

Revokes the registration information of an Agent.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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:

  • Key compromise

  • CA key compromise

  • Affiliation changed

  • Certificate superseded

  • Cessation of operation

  • Certificate hold

  • Remove from CRL

  • Privilege withdrawn

  • AA compromise

  • Unspecified

Affiliation changed

ReasonCode

string

Yes

The revocation reason code as defined in RFC 5280. Valid values:

  • unspecified: Unspecified. Default value. Used when the CA does not provide a specific reason or the reason is unknown. This is the most common code.

  • keyCompromise: Key compromise. The private key may have been obtained by an unauthorized party. This is the most severe reason and typically means the certificate must be revoked immediately and cannot be recovered.

  • cACompromise: CA key compromise. The private key of the CA that issued the certificate has been compromised. This affects all certificates issued by the CA and typically results in the revocation of the entire subtree.

  • affiliationChanged: Affiliation changed. The identity information of the certificate holder (such as name or organization name) has changed, but the public key remains valid. For example, an employee leaves the company or the company is renamed.

  • superseded: Certificate superseded. The certificate holder has applied for a new certificate (such as key rotation or algorithm upgrade), and the old certificate is revoked. The old key has not been compromised.

  • cessationOfOperation: Cessation of operation. The certificate holder no longer uses the key for related operations (such as server decommissioning or service termination). The key has not been compromised.

  • certificateHold: Certificate hold. Temporary revocation. Typically used for investigating suspicious activities or for administrative reasons. The hold can be removed later (Unhold) to make the certificate valid again. Note: This code cannot be used for final revocation.

  • removeFromCRL: Remove from CRL. Used only for delta CRLs (incremental revocation lists). Indicates that a certificate previously held by certificateHold has been released and should be removed from the revocation list. This is not a revocation reason but a status update instruction.

  • privilegeWithdrawn: Privilege withdrawn. The privileges or attributes granted in the certificate have been revoked (primarily used for Attribute Certificates and rarely for regular SSL/TLS certificates).

  • aACompromise: AA compromise. The key of the AA (Attribute Authority) that issued the attribute certificate has been compromised. This is also primarily used in the attribute certificate system.

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: The request was successful. false: The request failed.

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:

  • ExplicitDeny: Explicit deny.

  • ImplicitDeny: Implicit deny.

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.