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 authorize and authenticate it.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/monitor-policy
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
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: Default value: en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
monitor_switch |
Yes |
Boolean |
Whether to enable Monitoring by Seconds.
|
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. Values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Taskflow ID for modifying Monitoring by Seconds |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.