Creates a task that terminates sessions.
Operation description
- This operation is applicable only to ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters.
- If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
- If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| hdm:CreateKillInstanceSessionTask | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The instance ID. | rm-2ze8g2am97624**** |
| NodeId | string | No | The node ID. Note
This parameter must be specified if the database instance is a PolarDB for MySQL cluster. If you do not specify a node ID and set KillAllSessions to true, the system traverses all nodes in the PolarDB for MySQL cluster and terminates the active sessions on each node.
| pi-bp1v203xzzh0a**** |
| DbUser | string | Yes | The database account that has the permissions to terminate sessions. | testUser |
| DbUserPassword | string | Yes | The password of the database account. | testPassword |
| IgnoredUsers | string | No | The account whose sessions do not need to be terminated. Note
Set this parameter to a JSON array. Separate database accounts with commas (,). Example: ['Database account 1','Database account 2'].
| ['db_user1','db_user2'] |
| KillAllSessions | boolean | Yes | Specifies whether to terminate all sessions.
Note
If you set this parameter to true, sessions of the accounts that are specified by IgnoredUsers, sessions of internal O&M accounts of Alibaba Cloud, and Binlog Dump sessions are not terminated.
| true |
| SessionIds | string | No | The IDs of sessions that need to be terminated. Note
Set this parameter to a JSON array. Separate session IDs with commas (,). Example: ['Session ID1','Session ID2']. If KillAllSessions is set to true, this parameter does not take effect.
| [10805639,10805623,10805645,10805553,10805566,10805616] |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": 200,
"Message": "Successful",
"Data": "f77d535b45405bd462b21caa3ee8****",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": true
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. |
| 403 | NoPermission | You are not authorized to do this action. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history