Help Center/ Resource Governance Center/ API Reference/ Calling APIs/ Response
Updated on 2025-02-20 GMT+08:00
View PDF
Share

Response

Status Code

After sending a request, you will receive a response, including a status code, response header, and response body.

A status code is a group of digits, ranging from 2xx (indicating successes) to 4xx or 5xx (indicating errors). It indicates the status of a request. For more information, see Status Codes.

Response Header

Similar to a request, a response also has a header, for example, Content-type.

Table 1 describes common response headers.

Table 1 Common response headers

Header

Description

Content-Type

Type of the resource content.

Type: string

Default value: none

Connection

Whether the connection to the server is a long connection or a short connection.

Type: string

Valid values: keep-alive | close

Default value: none

Date

Date when the RGC service responded to the request.

Type: string

Default value: none

X-Request-Id

Unique identifier of the request. The value is generated by the RGC service and can be used for troubleshooting.

Type: string

Default value: none

Response Body

The body of a response is often returned in structured format as specified in the Content-type header. The response body transfers content except the response header.

The following is the response body for the API in Querying the Operating Status of a Governance Policy.

{
 "control_operation": {
  "operation_control_status_id": "c0jquihv-x3ve-1lb9-qmix-dankod8dg86z",
  "operation_type": "ENABLE_CONTROL",
  "status": "SUCCEEDED",
  "message": "",
  "start_time": "2024-04-19T16:26:30.518",
  "end_time": "2024-04-19T16:26:30.618"
 }
}

If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.

{
    "error_msg": "error msg",
    "error_code": "APIGW.0301",
    "request_id": "string"
}

In the response body, error_code is an error code, and error_msg provides information about the error.

Parent topic: Calling APIs