文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 实例管理> 设置实例秒级监控
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

设置实例秒级监控

功能介绍

设置实例秒级监控，包括1秒监控和5秒监控。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

monitor_switch

是

Boolean

实例秒级监控开关。

  • true：开启
  • false：关闭

period

否

Integer

采集周期。

  • 仅在“monitor_switch”为true时生效。默认为5s。

    取值范围：

    • 1：采集周期为1s。
    • 5：采集周期为5s。
  • “monitor_switch”为false时，无需传入该参数。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

修改秒级监控的任务流ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改实例秒级监控开关及频率，开启秒级监控，采集周期为1s。

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy
{
  "monitor_switch" : true,
  "period" : 1
}

响应示例

状态码： 200

Success.

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

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理