Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Enabling or Disabling Second-Level Monitoring
Updated on 2025-12-04 GMT+08:00
View PDF
Share

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 to 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

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID

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

To obtain this value, call the IAM API for obtaining a user token.

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

  • URI example 
    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/monitoring-by-seconds/switch
  • Example Requests

    Enabling second-level monitoring

    { 
   "enabled" : true 
 }

Example Responses

None

Status Codes

See Status Codes.

Error Codes

See Status Codes.

Parent topic: Instances