返回结果主要有JSON 格式,您可以指定公共请求参数 Format 变更返回结果的格式。更多详情,请参阅 公共参数。为了便于查看和美观,API 文档返回示例均有换行和缩进等处理,实际返回结果无换行和缩进处理。
正常返回示例:
接口调用成功后会返回接口返回参数和请求 ID,我们称这样的返回为正常返回。HTTP 状态码为 2xx。
JSON示例
{
"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
"Code" : "200"
}
异常返回示例:
接口调用出错后,会返回错误码、错误信息和请求 ID,我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。
您可以根据接口错误码,参考 公共错误码 以及 API 错误中心 排查错误。当您无法排查错误时,可以 提交工单 联系我们,并在工单中注明 RequestId。
JSON示例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
"Code" : "-2"
"Message":"xxxxxxx"
}
备注
更多返回错误代码请看公共API栏目下的公共错误代码文档描述