Triggers an ACME pre-check.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId may be different 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. In the multi-step registration process through the API, 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 completed. |
2074753647748672512 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
| Success |
boolean |
Indicates whether the global alert configuration is modified. Valid values:
|
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. The ID is automatically generated during the agent registration process. In the multi-step registration process through the API, 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 completed. |
2074753647748672512 |
| PrecheckStatus |
string |
The pre-check status. |
PASSED |
| Message |
string |
The ACME TXT verification message. |
ACME DNS-01 domain verification passed |
| VerifyTimestamp |
integer |
The DNS record verification time. |
1782572400000 |
| AccessDeniedDetail |
object |
The details about the access denial. This field is returned only when the 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 ID of the authorization principal owner. |
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 |
| ErrorCode |
string |
The error code. |
Success |
| ErrorMessage |
string |
The error message. |
PrecheckFailedOnTooManyVmSnapshot |
Examples
Success response
JSON format
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"Success": true,
"AgentRegisterInfoId": "2074753647748672512",
"PrecheckStatus": "PASSED",
"Message": "ACME DNS-01 domain verification passed.",
"VerifyTimestamp": 1782572400000,
"AccessDeniedDetail": {
"AuthAction": "RemoveRspDomainServerHoldStatusForGateway",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
},
"ErrorCode": "Success",
"ErrorMessage": "PrecheckFailedOnTooManyVmSnapshot"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.