Response

更新时间:
复制 MD 格式

Response parameters

Common parameters

Common return parameters are included in every response.

Name

Type

Description

RequestId

String

A unique identifier, RequestId, is returned for every request, regardless of success or failure. The system timeout is 10 seconds.

Common Return Parameters

Name

Type

Description

MessageId

String

The message ID that identifies a push. This ID is returned when a push is sent using an OpenAPI call. You can also view it in the push console.

XML example

<?xml version="1.0" encoding="UTF-8"?>
<!--Root node of the response-->
<APIName+Response>
    <!--Request ID tag-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--Response data-->
</APIName+Response>

JSON example

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* Response data */
}

Error responses

You can identify the cause of an API error by looking up the error code in the Error code table.

XML example

<?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 example

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