Docs

Network Advisor

Call Methods

Response examples

All returned data includes the fields of RequestId, Action, Version, Service, and Region.

Normal response example

After a successful API call, the response returns the request ID and API response parameters. This type of response is called a normal response. The HTTP status code of normal response is 2xx.

{​
    "ResponseMetadata": {​
        "RequestId": "202004011722300102****", // Obtained from the X-Top-Request-Id header.​
        "Action": "{Action}",//Obtained from the query of the request Action.​
        "Version": "{Version}",// Obtained from the Version query parameter.​
        "Service": "{Service}",// Obtained from the X-Top-Service header.​
        "Region": "{Region}" // Obtained from the X-Top-Region header.​
    },​
    "Result":"..."​
}​

After the request is processed properly, the response contains two parts: ResponseMetadata and Result. The field descriptions are as follows:

Field	Definition
RequestID	RequestID is the unique identifier for each API request.
Action	Name of the requested API, a common parameter for the request.
Version	Request version number, a common parameter for the request.
Service	Requested service, a common parameter for the request.

Result varies depending on the API called. Different APIs return different Results.

Error response example

When an API call fails, the response returns the request ID and error message. This type of response is called an error response. The HTTP status code of error response is 4xx or 5xx.

You can troubleshoot errors based on the API error code (Code) and error message (Message) by seeing Common error codes and API error codes.

{​
    "ResponseMetadata": {​
        "RequestId": "202010201722300102****",​
        "Action": "{Action}",​
        "Version": "{Version}",​
        "Service": "{Service}",​
        "Region": "{Region}",​
        "Error": {​
            "Code": "InvalidActionOrVersion",​
            "Message": "Could not find operation GetUserById for version 2020-04-01"​
        }​
    }​
}​

Compared to successful results, error results no longer include the Result field. Instead, the ResponseMetadata includes an additional Error field. Descriptions are as follows:

Field	Definition
Error	Error indicates that this request failed.
Code	Code contains the specific error code. You can view the error code documentation to resolve the issue independently.
Message	Message describes the specific cause of the error to assist your troubleshooting.
RequestID	RequestID is the unique identifier for each API request. If encountering issues that cannot be resolved independently, you can contact us via Ticket System and provide the RequestID of your request. We will provide troubleshooting support.

Last updated: 2026.08.04 19:32:43