Updated on 2026-09-22 GMT+08:00

Enabling or Disabling Second-Level Monitoring

Function

This API is used to enable or disable monitoring by 5s for an instance.

Constraints

This API can be used only for a proxy cluster GeminiDB Redis instances with four or more CPUs.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:setSecondLevelMonitoringConfig	write	instance *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	nosql:instance:secondLevelMonitoring	-

URI

PUT /v3/{project_id}/instances/{instance_id}/monitoring-by-seconds/switch

**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. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
enabled	Yes	Boolean	Definition Whether second-level monitoring is enabled Constraints N/A Range true: enabled false: disabled Default Value N/A

Response Parameters

None

Example Requests

Enabling monitoring by seconds

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/monitoring-by-seconds/switch

{ 
   "enabled" : true 
 }

Example Responses