Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Database O&M/ Enabling or Disabling a killOp Rule
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Enabling or Disabling a killOp Rule

API Description

This API is used to enable or disable a killOp rule.

Restrictions

  • This API applies only to replica set and cluster instances.
  • This API is available only for DDS 3.4 or later.
  • This API is available only for an instance node with 4 or more vCPUs.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/kill-op-rule

  • Table 1 Path parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region.

    instance_id

    Yes

    String

    Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

List of killOp rule IDs.

action

Yes

String
Enable or disable a killOp rule.
  • enable: Enable a killOp rule.
  • disable: Disable a killOp rule.
  • Example request 
    { 
   "ids" : [ "7d2f36b4-6edb-4093-8c78-810b30232943" ], 
   "action" : "enable" 
 }

Response Parameters

  • Parameter description

    None

  • Example response

    None

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Database O&M