Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Enabling or Disabling Second-Level Monitoring
Updated on 2024-12-31 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 to only on GeminiDB Redis instances with four or more CPUs in a proxy cluster.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

enabled

Yes

Boolean

Whether second-level monitoring is enabled

  • true: Enabled
  • false: Disabled

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.