edit-icon download-icon

Response structure

Last Updated: Sep 26, 2018

After you make an API request, an HTTP status code is returned. 2xx indicates that the request has succeeded; 4xx or 5xx indicates that an error occurred while processing the request. You can identify the cause of the error by using the HTTP status code and its description. If the problem cannot be solved, you can contact our support team, and provide the RequestId and the HostId which are included in the response of an unsuccessful request, to help us quickly find the resolution.

The response text is JSON formatted. If you make the API request by using tools that are not provided by Alibaba Cloud, you can customize the response format in the request parameters.

In the example responses we present as follows, we use line breaks to separate the original whole line of text for readability.

Successful response example

XML format

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--Result Root Node-->
  3. <InterfaceName+Response>
  4. <!--Return Request Tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!--Return Result Data-->
  7. </InterfaceName+Response>

JSON format

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

Unsuccessful response example

XML format

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

JSON format

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

Common error codes

Error code Error message HTTP status code
InternalFailure Internal Failure 500
SerivceUnavailableTemporary 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.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 exceededd 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
Rejected.StateModifiedFailed Keystate modified failed 409
Rejected.Disabled The request was rejected becasue the key state is Disabled 409
Rejetced.PendingDeletion The request was rejected becasue the key state is PendingDeletion 409
Rejected.PendingImport The request was rejected becasue the key state is PendingImport 409
Thank you! We've received your feedback.