doc-exports/docs/gaussdb_mysql/api-ref/ShowInstanceMonitorExtend.html

Querying the Collection Period of Monitoring by Seconds

Function

This API is used to query the collection period of Monitoring by Seconds. Before calling this API:

• Learn how to authorize and authenticate it.
• Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/monitor-policy

Table 1 URI parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DB instance ID.

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
monitor_switch	Boolean	Whether to enable Monitoring by Seconds. true indicates that the function is enabled, and false indicates that the function is disabled.
period	Integer	Collection period. This parameter is returned only when monitor_switch is set to true. 1: The collection period is 1s. 5: The collection period is 5s.

Status code: 400

Table 4 Response body parameters

Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

Table 5 Response body parameters

Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying the collection period of Monitoring by Seconds for an instance

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy

Example Response

Status code: 200

Success.

{
  "monitor_switch" : true,
  "period" : "1"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Managing DB Instances