Updated on 2026-03-16 GMT+08:00

Configuring Monitoring by Seconds

Function

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

Learn how to 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	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
monitor_switch	Yes	Boolean	Definition Whether to enable Monitoring by Seconds. Constraints N/A Range true: enabled false: disabled Default Value N/A
period	No	Integer	Definition Collection period. Constraints This parameter is only available when monitor_switch is set to true. This parameter is not displayed when monitor_switch is set to false. Range 1: The collection period is 1s. 5: The collection period is 5s. Default Value 5

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
job_id	String	Definition ID of the task for modifying Monitoring by Seconds. Range N/A

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