Responses

Updated at:

Each API call returns an HTTP status code. A 2xx code indicates success; a 4xx or 5xx code indicates failure.

Note

About responses:

  • Successful responses return data in JSON format only.

  • External systems can specify the response format in the request parameters.

  • Sample responses in this topic are formatted with line breaks for readability.

Sample success response

JSON sample:

{
  "Name": "CreateTest",
  "OssBucketName": "yuanchuang",
  "OssKeyPrefix": "",
  "RoleName": "aliyunactiontraildefaultrole"
}           

Sample error response

Failed API calls return no result data. Identify the error cause from the API-specific error code and the common error codes.

Error responses include the HTTP status code, error code, error message, and a globally unique request ID (RequestId). If you cannot identify the issue from the error code and message, provide the RequestId to technical support to trace the request log.

JSON sample:

{
  "RequestId": "0BC51021-1740-4C13-8072-4C1CD1D6B1F2",
  "Name": "CreateTest",
  "OssBucketName": "yuanchuang",
  "OssKeyPrefix": "",
  "RoleName": "aliyunactiontraildefaultrole"
}           

Common error codes

Name

Description

Status code

InvalidAction

Invalid action.

400

InvalidParameterValue

A parameter has an invalid value.

400

MissingAction

The Action parameter is missing.

400

MissingParameter

A required parameter is missing.

400

InvalidAccessKeyId.Inactive

The AccessKey ID is disabled.

403

NeedRamAuthorize

The specified RAM user does not exist.

403

InternalFailure

An unknown internal error occurred.

500

InternalServerError

An internal service error occurred.

500

ActionNotImplemented

The specified action is not implemented.

501

ServiceUnavailable

The service is unavailable.

503