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

Querying the Deadlock Switch Status

Function

This API is used to query 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::showCloudDBAInfo

    Read

    Instance

    -

    -

    -

URI

GET /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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Definition

Instance ID

Constraints

N/A

Range

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

Default Value

N/A

engine_type

Yes

String

Definition

DB engine type

Constraints

N/A

Range

  • sqlserver

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

switch_on

Boolean

Definition

Switch status

Range

N/A

retention_hours

Long

Definition

Retention period

Range

N/A

can_open

Boolean

Definition

Whether the function can be enabled

Range

N/A

cant_open_msg

String

Definition

Reason why the function cannot be enabled

Range

N/A

Example Requests

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/dead-lock/switch

Example Responses

Status code: 200

Success.

{ "switch_on": true, "retention_hours": 168, "can_open": true }

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.