全部产品
云市场

返回结果

更新时间:2019-06-25 21:33:31

返回结果为 JSON 格式。为了便于查看和美观,API 文档返回示例均有换行和缩进等处理,实际返回结果无换行和缩进处理。

正常返回示例

接口调用成功后会返回接口返回参数和请求 ID,我们称这样的返回为正常返回。HTTP 状态码为 2xx。

  • JSON 示例
    1. {
    2. "RequestId": "AC467B38-3910-447D-87BC-AC049166F216" /* 返回结果数据 */
    3. }

异常返回示例

接口调用出错后,会返回错误码、错误信息和请求 ID,我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。

您可以根据接口错误码,参考 公共错误码 以及 API 错误中心 排查错误。当您无法排查错误时,可以 提交工单 联系我们,并在工单中注明服务节点 HostIdRequestId

  • JSON 示例
    1. {
    2. "RequestId": "A40CFF28-407A-40B5-B6A5-AC049166F216", /* 请求 ID */
    3. "HostId": "oos.cn-hangzhou.aliyuncs.com", /* 服务节点 */
    4. "Code": "InvalidNextToken", /* 错误码 */
    5. "Message": "NextToken is invalid" /* 错误信息 */
    6. }

公共错误码

错误代码 HTTP 状态码 错误信息 描述
InvalidVersion 400 Specified parameter Version is not valid. 给定的Version非法。请检查URL中指定的Version的正确性。
InvalidAction.NotFound 400 Specified api is not found, please check your url and method. 给定的API不存在。请检查URL中指定的Action的正确性。
Throttling.User 400 Request was denied due to user flow control. 访问频率太高导致流控。
InvalidParameter 400 内容随校验场景不同而不同,如
TemplateName can not contain “*”
参数非法。请根据错误信息来检查指定参数的正确性。
User.NoPermission 400 User has no permission to do the action: ({api_name}) 用户没有调用某个API的权限。请检查是否在RAM中给当前用户赋予了OOS的API的权限。
InvalidStsToken 400 Invalid STS token to do the action: ({api_name}) 给定的STS Token非法。
ExpiredStsToken 400 Expired STS token to do the action: ({api_name}) 给定的STS Token过期。
MissingParameter 400 The Parameter ({name}) was not provided. 缺少必填参数。
QuotaExceed 400 The Quota ({key}) exceeded ({value}). 特定属性(如模板数量、正在运行的执行数等)超过上限。
InvalidAccountType 400 The account type ({account_type}) was not supported. 不支持给定的账号类型。
TemplateValidationError 400 {reason} 模板约束,如参数类型、数值等,校验不通过。
InvalidFunctionParameters 400 The specified function {fn_name}’s parameters are incorrect. 模板中使用函数时给定的参数校验错误。请检查参数的数量和值。
InvalidTemplateReference 400 The specified reference {resource} (in {key}) is incorrect. 模板内参数引用不正确。
UnknownUserParameter 400 The parameter ({key}) was not defined in engine. 模板中给定的参数未定义或不被支持。
InvalidTimerTriggerParameter 400 The parameter ({key}) is invalid TimerTrigger动作的给定参数非法。
InvalidTemplateParameter 400 The parameter ({key}) has no attributes. 模板中的Parameters类型非法,必须为字典。