您调用API服务后,系统会返回HTTP状态码。如果返回的状态码为2xx,代表调用成功;返回4xx或5xx代表调用失败。
调用成功返回的数据格式暂时只支持JSON。
如果您使用外部系统发送请求,可在参数中定制返回的数据格式。
本文档中的返回示例为了便于用户查看,做了断行处理。
成功结果
JSON
示例
{
"Name": "CreateTest",
"OssBucketName": "yuanchuang",
"OssKeyPrefix": "",
"RoleName": "aliyunactiontraildefaultrole"
}
错误结果
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码以及公共错误码来定位错误原因。
当调用出错时,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 |
原创文章,作者:网友投稿,如若转载,请注明出处:https://www.cloudads.cn/archives/34009.html