Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Enabling or Disabling Second-Level Monitoring
Updated on 2025-11-17 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

Each account is authorized to call all APIs, but its IAM users must be granted necessary permissions. For details, see Permission Policies and Supported Actions.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

Instance ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

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

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

enabled

Yes

Boolean

Explanation:

Whether second-level monitoring is enabled

Constraints:

N/A

Values:

  • true: enabled
  • false: disabled

Default value:

N/A

Response Parameters

None

Example Request

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

    Enabling second-level monitoring

    { 
   "enabled" : true 
 }

Example Response

None

Status Codes

See Status Codes.

Error Codes

See Status Codes.

Parent topic: Instances