SubmitAtiAgentRegisterInfo - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Submits Agent registration information.

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 to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ 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. During API-based registration and query processes, this ID must be carried throughout. Call the ListAtiAgentRegisterInfos operation to query the target Agent and obtain the AgentRegisterInfoId from the response.	2074753647748672512
IdentityCsr	string	Yes	The identity certificate CSR request. You can generate this by referring to the identity certificate CSR request guidance command provided in Step 3 of the Register Agent process in the ATS console.	-----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFAD... (A long string of Base64-encoded data) ... -----END CERTIFICATE-----
ServerCertPem	string	Yes	The server certificate, which is the certificate corresponding to the domain name (host address) used for Agent registration.	-----BEGIN CERTIFICATE----- KsdeFSAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFAD... (A long string of Base64-encoded data) ... -----END CERTIFICATE-----

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique request ID.	6856BCF6-11D6-4D7E-AC53-FD579933522B
Status	boolean	The Agent status. Valid values: Draft: The Agent registration form is being filled in and has not been formally submitted. In the Draft state, only modification and detail viewing operations are supported. Other operations are not supported. Private CA Pending Issuance: The Agent registration has been formally submitted. Alibaba Cloud has completed the ACME DNS-01 pre-check and submitted the registration information and generated DNS records to CNNIC. The system is waiting for CNNIC to approve and issue the Private CA and complete TL sealing. DNS Pending Verification: CNNIC has approved the request, issued the Private CA certificate, and completed TL sealing, but the DNS records of the user have not been verified. The user needs to add the corresponding DNS records in domain name resolution and complete verification. Active: All processes are complete. The Private CA certificate has been issued, TL has been sealed, and DNS records have been verified. The Agent is activated and can be discovered and trusted across the network. Expired: The Agent identity certificate has expired, and the user did not complete certificate renewal within the validity period. Revoked: The Agent certificate has been revoked, DNS records have been cleaned up, and the Agent cannot be discovered or trusted. It cannot be restored to the Active state.	Private CA 待签发
AccessDeniedDetail	object	The access denied details. This field is returned only when RAM authentication fails.
AuthAction	string	The unauthorized operation that was attempted.	AddRspDomainServerHoldStatusForGateway
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",
  "Status": true,
  "AccessDeniedDetail": {
    "AuthAction": "AddRspDomainServerHoldStatusForGateway",
    "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.