Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Changing the Deadlock Switch Status
Updated on 2026-08-25 GMT+08:00

Changing the Deadlock Switch Status

Function

This API is used to change the deadlock switch status. It applies only to SQL Server instances.

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

    das:clouddba:changeSqlSwitch

    Write

    Instance

    -

    -

    -

URI

POST /v3/{project_id}/dead-lock/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

The value can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

engine_type

Yes

String

Definition

DB engine type

Constraints

N/A

Range

MySQL

Default Value

N/A

switch_on

Yes

Boolean

Definition

Switch status

Constraints

N/A

Range

  • false: disabled
  • true: enabled

Default Value

N/A

instance_id

Yes

Boolean

Definition

Instance ID

Constraints

N/A

Range

  • The value can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

retention_hours

Yes

Boolean

Definition

Retention period

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Definition

Whether the request is successful

Range

N/A

status

String

Definition

Status value

Range

  • 1: successful
  • 2: failed, no polling required
  • 3: failed, polling required

error_msg

Boolean

Definition

Error message

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/dead-lock/switch
 
{
  "instance_id": "47d0524891964dc48cee42c371928777in04",
  "switch_on": true,
  "engine_type": "sqlserver",
  "retention_hours": 168
}

Example Responses

Status code: 200

Success.

{
  "success": true,
  "status": 1
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.