Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Configuring the Monitoring By Seconds Function
Updated on 2023-10-18 GMT+08:00
View PDF

Configuring the Monitoring By Seconds Function

Function

This API is used to configure the Monitoring By Seconds function for instances. You can set the monitoring interval to 1 second or 5 seconds to view the metric values. Before calling this API:

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

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

monitor_switch

Yes

Boolean

Whether to enable Monitoring by Seconds.

  • true: enabled
  • false: disabled

period

No

Integer

Collection period.

  • This parameter is valid only when monitor_switch is set to true. The default value is 5s.

    Value:

    • 1: The collection period is 1s.
    • 5: The collection period is 5s.
  • This parameter is not specified when monitor_switch is set to false.

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

Enabling Monitoring by Seconds and changing its collection period to 1s

PUT https://{endpoint}/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: Instance Management