API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call. Response data can be returned in the JSON format. If you make an API request by using third-party tools, you can customize the response format in the request parameters.

Sample success responses

XML format

<? xml version="1.0" encoding="UTF-8"? > 
<! --Result Root Node-->
<Interface Name+Response>
    <! --Return Request Tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <! --Return Result Data-->
</Interface Name+Response>

JSON format

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* Return Result Data */
}

Sample error responses

When an error occurs during an API call, response data is not returned. You can locate the cause of an error based on the corresponding error code and Common error codes.

When an error occurs during a call, an HTTP status code of 4xx or 5xx is returned. The returned message includes the specific error code and message. It also contains a globally unique request ID (RequestId) and the ID of the site you accessed with this request (HostId). If you cannot locate the cause of a failed API call, we recommend that you contact Alibaba Cloud customer service with the corresponding HostId and RequestId to help resolve the issue.

XML format (an expired request)

<KMS>
<HttpStatus>400</HttpStatus>
<Code>IllegalTimestamp</Code>
<Message>The input parameter "Timestamp" that is mandatory for processing this request is not supplied. </Message>
<RequestId>3b237773-bc2c-4bea-95fc-319a1a5baa68</RequestId>
</KMS>

JSON format (an expired request)

{
"HttpStatus": 400
"Code": "IllegalTimestamp"
"Message": "The input parameter "Timestamp" that is mandatory for processing this request is not supplied."
"RequestId": "e85db688-a2d3-44ca-9790-4259f59e90d8"
}

Common error codes

Error code Description  HTTP status code
InternalFailure Internal Failure. 500
ServiceUnavailableTemporary Service Unavailable Temporary. 503
InvalidAccessKeyId.NotFound The AccessKey ID provided does not exist in our records. 404
Forbidden.KeyNotFound The specified Key is not found. 404
Forbidden.KeyVersionNotFound The specified Key version is not found. 404
Forbidden.AliasNotFound The specified Alias is not found. 404
Forbidden.NoPermission This operation is forbidden by permission system. 403
Forbidden.AccessKey This AccessKey is not enabled. 403
UnsupportedHTTPMethod This http method is not supported. 403
Forbidden.UbsmsInvalidUserid Userid Invalid For Ubsms. 403
Forbidden.UbsmsInvalidBid Your account partner does not have KMS Service. 403
Forbidden.KmsServiceNotEnabled Kms service is not Enabled for current user. Please get access permission first. 403
Forbidden.ProhibitedByRiskControl Current user is Prohibited By Risk Control. 403
Forbidden.InDebtOverdue Current user is indebted Overdue. 403
Forbidden.InDebt Current user is indebted. 403
ParseRequestParameterException Server parse parameters exception. Please check your input params. 400
MissingParameter The parameter "< parameter name >" is needed but not provided. 400
InvalidParameter The specified parameter "< parameter name >" is not valid. 400
IncompleteSignature The request signature does not conform to Alibaba Cloud standards. 400
IllegalTimestamp The input parameter "Timestamp" that is required for processing this request is not supplied. 400
Rejected.LimitExceeded The request was rejected because user create resource limit was exceeded. 400
AliasAlreadyExists AliasName Already Exists. 400
InvalidKeyMaterial key material is invalid. 400
InvalidImportToken import token is invalid. 400
ExpiredImportToken import token is expired. 400
Unsupported.Origin This key origin is not valid for this api. 400
Unsupported.Alias Alias is not valid for this api. 400
Unsupported.ProtectionLevel This protection level is not valid for this region 400
Rejected.StateModifiedFailed Keystate modified failed. 409
Rejected.Disabled The request was rejected because the key state is Disabled. 409
Rejected.PendingDeletion The request was rejected because the key state is PendingDeletion. 409
Rejected.PendingImport The request was rejected because the key state is PendingImport. 409