Response results #

All responses include the fields RequestId, Action, Version, Service, Region, and other fields.

Sample response #

After a successful API call, RequestId and response parameters are returned. Such a 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":"..."
}

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

Sample response #

When an API call fails, RequestId and error information are returned. Such a 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 to troubleshoot errors.

{
    "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 the ResponseMetadata will additionally include an Error field, which contains Code and Message. The field explanations are as follows: