调用API服务后,系统会返回HTTP状态码。如果返回的状态码为2xx,表示调用成功。如果返回的状态码为4xx或5xx,表示调用失败。

说明

对于返回结果的说明如下:

  • 调用成功返回的数据格式暂时只支持JSON。
  • 如果您使用外部系统发送请求,可在参数中定制返回的数据格式。
  • 本文档中的返回示例为了便于用户查看,做了断行处理。

正常返回示例

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

异常返回示例

调用接口出错后,不会返回结果数据。调用方可根据每个接口对应的错误码以及公共错误码来定位错误原因。

调用API报错后,将在response中返回HTTP状态码、错误码和错误信息,还会包括该次请求在全局的唯一标识RequestId。若您根据错误码和错误信息无法明确问题,可将RequestId提供给技术支持人员,帮忙快速定位到该条请求日志。

JSON示例

{
  "RequestId": "0BC51021-1740-4C13-8072-4C1CD1D6B1F2",
  "HostId": "actiontrail.cn-hangzhou.aliyuncs.com",
  "Code": "TrailAlreadyExistsException",
  "Message": "account name(CreateTest) and region(cn-hangzhou) is already exist"
}
			

公共错误码

名称 描述 状态码
InvalidAction 非法的Action。 400
InvalidParameterValue 不支持的参数值。 400
MissingAction 缺少Action参数。 400
MissingParameter 缺少必选参数。 400
InvalidAccessKeyId.Inactive AccessKeyId被禁用。 403
NeedRamAuthorize RAM授权用户不存在。 403
InternalFailure 内部服务未知错误。 500
InternalServerError 内部服务错误。 500
ActionNotImplemented 指定的Action未实现。 501
ServiceUnavailable 服务不可用。 503