Setting the SQL Switches

Function

This API is used to set all query logs, slow query logs, deadlock, lock blocking, and retention duration.

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:write

Write

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
das:clouddba:write	Write	-	-	-	-

URI

POST /v3/{project_id}/instance/set-sql-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 N/A Default Value N/A
instance_id	Yes	String	Definition Unique ID of an instance Constraints N/A Range The value can contain 32 characters. Only letters and digits are supported. Default Value N/A
full_sql_switch_on	No	Boolean	Definition DB engine type Constraints N/A Range N/A Default Value N/A
full_sql_retention_hours	No	Long	Definition DB engine type Constraints N/A Range N/A Default Value N/A
full_sql_switch_on	No	Boolean	Definition Switch for enabling or disabling Collect All Query Logs Constraints N/A Range N/A Default Value N/A
full_sql_retention_hours	No	Long	Definition Retention duration of all SQL statements Constraints N/A Range N/A Default Value N/A
slow_sql_switch_on	No	Boolean	Definition Switch for enabling or disabling Collect Slow Query Logs Constraints N/A Range N/A Default Value N/A
slow_sql_retention_hours	No	Long	Definition Retention duration of slow query logs Constraints N/A Range N/A Default Value N/A
dead_lock_switch_on	No	Boolean	Definition Deadlock switch Constraints N/A Range N/A Default Value N/A
dead_lock_retention_hours	No	Long	Definition Retention duration of deadlocks Constraints N/A Range N/A Default Value N/A
lock_blocking_switch_on	No	Boolean	Definition Lock wait switch Constraints N/A Range N/A Default Value N/A
lock_blocking_retention_hours	No	Long	Definition Lock wait storage duration 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/instance/set-sql-switch 
 
{
    "engine_type": "sqlserver",
    "instance_id": "47d0524891964dc48cee42c371928777in04",
    "slow_sql_switch_on": true,
    "slow_sql_retention_hours": 168,
    "full_sql_switch_on": true,
    "full_sql_retention_hours": 168,
    "dead_lock_switch_on": true,
    "dead_lock_retention_hours": 168,
    "lock_blocking_switch_on": true,
    "lock_blocking_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.

Parent topic: Intelligent O&M

Previous topic: Obtaining Metric Data of Instances in Batches

Next topic: Obtaining a User Instance