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

Changing the Collection Period of Monitoring by Seconds

Function

This API is used to enable and disable Monitoring by Seconds, and change its collection period. Before calling this API, you can:

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

URI

PUT /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.

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
monitor_switch	Yes	Boolean	Whether to enable Monitoring by Seconds. true indicates that the function is enabled, and false indicates that the function is disabled.
period	No	Integer	Collection period. This parameter is available only when monitor_switch is set to true. The default value is 5s. This parameter is not displayed when monitor_switch is set to false. 1: indicates that the collection period is 1s. 5: indicates that the collection period is 5s. Valid value: 1 5

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
job_id	String	Taskflow ID for modifying Monitoring by Seconds

Status code: 400

Table 5 Response body parameters

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

Status code: 500

Table 6 Response body parameters

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

Example Request

Modifying the collection period of Monitoring by Seconds for an instance. The current collection period to 1s.

PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy
{
  "monitor_switch" : true,
  "period" : 1
}

Example Response

Status code: 200

Success.

{
  "job_id" : "6b7dd5d4-4590-4f14-b164-a8737ce071d5"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Managing DB Instances