返回结果_API 调用方式_OpenAPI 2.0_开发指南

返回参数

公共返回参数

公共返回参数是指每次请求都会返回的参数

名称	类型	描述
RequestId	String	用户每次请求，无论成功与否（系统超时：10秒），系统都会返回一个唯一识别码`RequestId`给用户

常见返回参数

名称	类型	描述
MesssageId	String	标志一次推送的消息ID，基于OpenAPI 接口推送时返回，或者在推送控制台查看。

XML示例

<?xml version="1.0" encoding="UTF-8"?>
<!—结果的根结点-->
<接口名称+Response>
    <!—返回请求标签-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!—返回结果数据-->
</接口名称+Response>

JSON示例

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 返回结果数据 */
}

错误结果

调用方可根据每个接口对应的错误码以及错误代码表来定位错误原因。

XML示例

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <Code>InvalidAccessKeyId.NotFound</Code>
   <Message>The Access Key ID provided does not exist in our records.</Message>
</Error>

JSON示例

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "InvalidAccessKeyId.NotFound",
    "Message": "The Access Key ID provided does not exist in our records."
}