Updated on 2024-05-20 GMT+08:00

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

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/2900b7b8d03e4619b8db8d43bc6234ee/instances/6390733773d64a748f3a7bc88df22384in02/kill-op-rule

    Table 1 Request parameters

    Parameter

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    User token obtained from IAM. For details, see Authentication.

    project_id

    Yes

    String

    Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

    instance_id

    Yes

    String

    Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Requests

  • Parameter description
    Table 2 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" 
     }

Responses

  • Parameter description

    None

  • Example response

    None

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.