All Products
Search
Document Center

Returned Results

Last Updated: Nov 04, 2016

After the API service is called, the returned data adopts a uniform format. A returned HTTP status code of 2xx indicates that the call was successful. A returned HTTP status code of 4xx or 5xx indicates that the call was unsuccessful. For successful calls, the supported formats of returned data are XML and JSON. When a request is sent, an external system can pass in parameters to specify the format of returned data. XML is the default format. In this document, examples of results returned are formatted in a way that is easier for users to view. The actual results returned are not formatted with line breaks, indentation, etc.

Successful Results

XML Examples:

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

JSON Examples:

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

Error Results

After an error is encountered in an interface call, no result data will be returned. The caller can pinpoint the causes of error based on the error codes corresponding to each interface and the public error codes that are listed in 2.3.3 below.

When an error occurs in a call, the HTTP request will return an HTTP status code of 4xx or 5xx. The returned message body includes the specific error code and error message. It also contains a globally unique request ID: RequestId and the ID of the site you accessed with this request: HostId. If the caller cannot find the cause of the error, he can contact Alibaba Cloud customer service and provide the HostId and RequestId to help us solve the problem as quickly as possible.

XML Examples:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Error>
  3. <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
  4. <HostId>vpc.aliyuncs.com</HostId>
  5. <Code>UnsupportedOperation</Code>
  6. <Message>The specified action is not supported.</Message>
  7. </Error>

JSON Examples:

  1. {
  2. "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
  3. "HostId": "vpc.aliyuncs.com",
  4. "Code": "UnsupportedOperation",
  5. "Message": "The specified action is not supported."
  6. }

Public Error Codes

Error code Description Http status code Meaning
MissingParameter The input parameter “Action” that is mandatory for processing this request is not supplied 400 The Action field missing
MissingParameter The input parameter “AccessKeyId” that is mandatory for processing this request is not supplied 400 The AccessKeyId field missing
MissingParameter An input parameter “Signature” that is mandatory for processing the request is not supplied. 400 The Signature field missing
MissingParameter The input parameter “TimeStamp” that is mandatory for processing this request is not supplied 400 The Timestamp field missing
MissingParameter The input parameter “Version” that is mandatory for processing this request is not supplied 400 The Version field missing
InvalidParameter The specified parameter “Action or Version” is not valid. 400 Invalid Action value (This API does not exist)
InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records. 400 Invalid AccessKeyId value (This key does not exist)
Forbidden.AccessKeyDisabled The Access Key is disabled. 403 The AccessKey is disabled
IncompleteSignature The request signature does not conform to Alibaba Cloud standards. 400 Invalid Signature value (incorrect signature result)
InvalidParamater The specified parameter “SignatureMethod” is not valid. 400 Invalid SignatureMethod value
InvalidParamater The specified parameter “SignatureVersion” is not valid. 400 Invalid SignatureVersion value
IllegalTimestamp The input parameter “Timestamp” that is mandatory for processing this request is not supplied. 400 Invalid Timestamp value (The gap between Timestamp and server time exceeds one hour)
SignatureNonceUsed The request signature nonce has been used. 400 Invalid SignatureNonce (This SignatureNonce value has been used)
InvalidParameter The specified parameter “Action or Version” is not valid. 400 Invalid Version value
InvalidOwnerId The specified OwnerId is not valid. 400 Invalid OwnerId value
InvalidOwnerAccount The specified OwnerAccount is not valid. 400 Invalid OwnerAccount value
InvalidOwner OwnerId and OwnerAccount can’t be used at one API access. 400 The OwnerId and OwnerAccount are used at the same time
Throttling Request was denied due to request throttling. 400 Access is denied due to the system traffic control
Throttling Request was denied due to request throttling. 400 The call quota for this key is used up
InvalidAction Specified action is not valid. 403 This key is not authorized to call this API
UnsupportedHTTPMethod This http method is not supported. 403 The user adopts unsupported Http method (currently TOP only supports post and get)
ServiceUnavailable The request has failed due to a temporary failure of the server. 500 The service is unavailable
UnsupportedParameter The parameter “<parameter name>” is not supported. 400 Invalid parameter is used
InternalError The request processing has failed due to some unknown error, exception or failure. 500 Other causes
MissingParameter The input parameter OwnerId,OwnerAccount that is mandatory for processing this request is not supplied. 403 No assigned OwnerId when calling this interface
Forbidden.SubUser The specified action is not available for you 403 Not authorized to call the Order class interface
UnsupportedParameter The parameter “<parameter name>” is not supported. 400 Not authorized to use this parameter
Forbidden.InstanceNotFound The specified Instance does not exist, so we cannot get enough information to check permission in RAM. 404 RAM is used to provide cross-account access to resources, but the Instance involved in the access does not exist
Forbidden.DiskNotFound The specified Disk does not exist, so we cannot get enough information to check permission in RAM. 404 RAM is used to provide cross-account access to resources, but the Disk involved in the access does not exist
Forbidden.SecurityGroupNotFound The specified SecurityGroup does not exist, so we cannot get enough information to check permission in RAM. 404 RAM is used to provide cross-account access to resources, but the SecurityGroup involved in the access does not exist
Forbidden.SnapshotNotFound The specified Snapshot does not exist, so we cannot get enough information to check permission in RAM. 404 RAM is used to provide cross-account access to resources, but the Snapshot involved in the access does not exist
Forbidden.ImageNotFound The specified Image does not exist, so we cannot get enough information to check permission in RAM. 404 RAM is used to provide cross-account access to resources, but the Image involved in the access does not exist
Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM. 403 RAM is used to provide cross-account access to resources, but users are not authorized to perform the operation this time
Forbidden.NotSupportRAM This action does not support accessed by RAM mode. 403 RAM is not allowed to be used to access this interface (use of ResourceOwnerAccount not allowed)
Forbidden.RiskControl This operation is forbidden by Alibaba Cloud Risk Control system. 403 Access denied by Alibaba Cloud Risk Control system
InsufficientBalance Your account does not have enough balance. 400 Insufficient balance
IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. 400 A used ClientToken is used for the request, which is different from the previous request with the used token.
RealNameAuthenticationError Your account has not passed the real-name authentication yet. 403 Real-name authentication is not performed by the user
InvalidIdempotenceParameter.Mismatch The specified parameters are different from before 403 Idempotence parameters do not match
LastTokenProcessing The last token request is processing 403 The previous request is still being processed
InvalidParameter The specified parameter is not valid 400 Parameter verification failed