文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ 实例管理/ 查询实例秒级监控
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例秒级监控

功能介绍

查询实例秒级监控信息。

URI

GET /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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

monitor_switch

Boolean

实例秒级监控开关。

  • true：表示开启。
  • false：表示关闭。

period

Integer

采集周期，仅在“monitor_switch”为true时返回。

  • 1：采集周期为1s。
  • 5：采集周期为5s。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例秒级监控状态。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy

响应示例

状态码： 200

Success.

{
  "monitor_switch" : true,
  "period" : "1"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理