Responses

Last updated: 2019-12-05 11:32:00

PDF

Response for Successful Requests

For example, when calling CAM API (version: 2017-03-12) to view the status of instances (DescribeInstancesStatus), if the request has succeeded, you may see the response as shown below:

{
    "Response": {
        "TotalCount": 0,
        "InstanceStatusSet": [],
        "RequestId": "b5b41468-520d-4192-b42f-595cc34b6c1c"
    }
}
  • The API will return Response, which contains RequestId, as long as it processes the request. It does not matter if the request is successful or not.
  • RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.
  • Except for the fixed fields, all fields are action-specified. For the definitions of action-specified fields, see the corresponding API documentation. In this example, TotalCount and InstanceStatusSet are the fields specified by the API DescribeInstancesStatus. 0 TotalCount means that the requester owns 0 CVM instance so the InstanceStatusSet is empty.

Response for Failed Requests

If the request has failed, you may see the response as shown below:

{
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "The provided credentials could not be validated. Please ensure your signature is correct."
        },
        "RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
    }
}
  • The presence of the Error field indicates that the request has failed. A response for a failed request will include Error, Code and Message fields.
  • Code is the code of the error that helps you identify the cause and solution. There are two types of error codes so you may find the code in either common error codes or API-specified error codes.
  • Message explains the cause of the error. Note that the returned messages are subject to service updates. The information the messages provide may not be up-to-date and should not be the only source of reference.
  • RequestId is the unique ID of an API request. Contact us with this ID when an exception occurs.

Common Error Codes

If there is an Error field in the response, it means that the API call failed. The Code field in Error indicates the error code. The following table lists the common error codes that all actions can return.

Error Code Description
AuthFailure.InvalidSecretId Invalid key (not a TencentCloud API key type).
AuthFailure.MFAFailure MFA failed.
AuthFailure.SecretIdNotFound The key does not exist.
AuthFailure.SignatureExpire Signature expired.
AuthFailure.SignatureFailure Signature error.
AuthFailure.TokenFailure Token error.
AuthFailure.UnauthorizedOperation The request does not have CAM authorization.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
InternalError Internal error.
InvalidAction The API does not exist.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
LimitExceeded Quota limit exceeded.
MissingParameter A parameter is missing.
NoSuchVersion The API version does not exist.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse Resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
UnsupportedProtocol HTTPS request method error. Only GET and POST requests are supported.
UnsupportedRegion API does not support the requested region.