全部产品

返回结果

更新时间:2017-06-07 13:26:11   分享:   

调用API服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式暂时支持JSON,外部系统可以在请求时传入参数来制定返回的数据格式。本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

JSON示例

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

错误结果

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

当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId。在调用方找不到错误原因时,可以联系阿里云客服,并提供该HostId和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
Inactive 用户指定的名字 403
NeedRamAuthorize RAM授权用户不存在 403
InternalFailure 内部服务未知错误 500
InternalServerError 内部服务错误 500
ActionNotImplemented 指定的Action未实现 501
ServiceUnavailable 服务不可用 503
本文导读目录
本文导读目录
以上内容是否对您有帮助?