Response results #

All responses include fields such as RequestId, Action, Version, Service, Region, and more.

Normal sample response #

When the API call is successful, RequestId and response parameters are returned. This type of response is referred to as a normal response. The HTTP status code is 2xx.

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}"
    },
    "Result":"..."
}

After the request is processed successfully, the response contains two parts: ResponseMetadata and Result. The Result depends on the specific API called, and different APIs will return different Result content. The field explanations are as follows:

Error sample response #

If an error occurs during the API call, RequestId and error information are returned. This type of response is referred to as an error response. The HTTP status code is 4xx or 5xx.
You can use the API error code (Code) and error message (Message) to refer to the public error codes and API error codes for troubleshooting.

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
        "Error": {
            "Status": null,
            "Code": "InvalidRequest",
            "BizCode": "InvalidRequest",
            "ProviderCode": "EMR"
            "Message": "Access Denied emr-xxx"
        }
    }
    "Result": null
}

Compared to a successful result, the Result part of an error result will be null, and an additional Error field will appear in ResponseMetadata, including Code and Message. The field explanations are as follows: