VerifyAtiAgentDnsRecords - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Verifies DNS records.

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 in length. 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 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
		No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	B57C121B-A45F-44D8-A9B2-XXXXXXX
Success	boolean	Indicates whether the operation to delete the domain name instance configuration is successful. Valid values: true: The operation is successful. false: The operation failed.	true
AgentRegisterInfoId	string	The Agent registration ID. This ID is automatically generated by the Alibaba Cloud ATS platform and is globally unique within the platform.	2074753647748672512
AllVerified	boolean	Indicates whether all DNS records have been verified.	true
AgentStatus	string	The Agent status.	Active
Results	object
Result	array<object>	The result.
	object	The verification result.
RecordName	string	The record name.	_acme-challenge.www.ats-client.asia
RecordType	string	The DNS type of the record, such as TLSA or TXT.	TXT
VerifyStatus	string	The DNS record verification status. Valid values: Verified Not verified You must configure the generated DNS records under the corresponding domain name. DNS record verification must be completed to activate the Agent. DNS record verification ensures that other Agents can discover the current Agent through DNS resolution.	VERIFIED
FailReason	string	The failure reason.	Subject to the actual return value
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.	AddRspDomainServerHoldStatusForGatewayOte
AuthPrincipalDisplayName	string	The display name of the authorization principal.	2015555733387XXXX
AuthPrincipalOwnerId	string	The owner ID of the authorization principal.	1046973331XXXX
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": "B57C121B-A45F-44D8-A9B2-XXXXXXX",
  "Success": true,
  "AgentRegisterInfoId": "2074753647748672512",
  "AllVerified": true,
  "AgentStatus": "活跃",
  "Results": {
    "Result": [
      {
        "RecordName": "_acme-challenge.www.ats-client.asia",
        "RecordType": "TXT",
        "VerifyStatus": "VERIFIED",
        "FailReason": "以实际返回为准"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "AddRspDomainServerHoldStatusForGatewayOte",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "1046973331XXXX",
    "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.