CreateAtiAgentRegisterInfoAcmeChallengeRecord - Alibaba Cloud DNS

Registers an agent - Step 2: Generates a DNS record for domain ownership verification.

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 unique parameter value from your client to ensure that the value is unique across different requests. The ClientToken value 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 value. 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. The ID is automatically generated during the agent registration process. When registering or querying through APIs, this ID must be carried throughout the entire process. Call the ListAtiAgentRegisterInfos operation to query the target agent and obtain the AgentRegisterInfoId from the response.	2074031103110331392

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	29D0F8F8-5499-4F6C-9FDC-1EE13BF55925
UpdateTimestamp	string	The update time (UNIX timestamp).	1565505898000
AgentRegisterInfoId	string	The agent registration ID. This ID is automatically generated by the Alibaba Cloud ATS platform and is globally unique within the platform. The ID is automatically generated during the agent registration process. In the multi-step registration process through APIs, this ID must be carried throughout all steps to ensure that each step is associated with the same agent and the complete registration process is fulfilled.	2074031103110331392
CreateTimestamp	string	The creation time (UNIX timestamp).	1527690629357
ExpireTimestamp	string	The time when the instance expires (UNIX timestamp).	1528284856000
RecordName	string	The host record of the domain ownership verification DNS record.	_acme-challenge.www
RecordType	string	The type of the domain ownership verification DNS record. The value is typically TXT.	TXT
RecordValue	string	The record value of the domain ownership verification DNS record.	YkKL7G2TRSAWRRBZ1RcAMeuRYx3Jv28o20yIGmdcYuz
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.	RemoveRspDomainServerHoldStatusForGateway
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 encoded diagnostic message.	AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==
NoPermissionType	string	The reason for the authentication failure. Valid values: ExplicitDeny: Explicit deny. ImplicitDeny: Implicit deny.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend
Records	object
Record	array<object>
	object
RecordType	string
RecordName	string
RecordValue	string
DomainScope	string

Examples

Success response

JSON format

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "UpdateTimestamp": "1565505898000",
  "AgentRegisterInfoId": "2074031103110331392",
  "CreateTimestamp": "1527690629357",
  "ExpireTimestamp": "1528284856000",
  "RecordName": "_acme-challenge.www",
  "RecordType": "TXT",
  "RecordValue": "YkKL7G2TRSAWRRBZ1RcAMeuRYx3Jv28o20yIGmdcYuz",
  "AccessDeniedDetail": {
    "AuthAction": "RemoveRspDomainServerHoldStatusForGateway",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  },
  "Records": {
    "Record": [
      {
        "RecordType": "",
        "RecordName": "",
        "RecordValue": "",
        "DomainScope": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.