Kill Active Sessions Automatically with CreateKillInstanceSessionTask - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Operation description

This operation is applicable only to ApsaraDB RDS for MySQL and PolarDB for MySQL instances.
When using the Alibaba Cloud or DAS SDK, use the latest version.
When calling DAS by using the SDK, set the region to cn-shanghai.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:CreateKillInstanceSessionTask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
NodeId	string	No	The node ID. Note For PolarDB for MySQL instances, provide the node ID. If no node ID is provided and the KillAllSessions request parameter is set to true (terminate all sessions), the system traverses all nodes of the PolarDB for MySQL instance and terminates ongoing sessions on each node.	pi-bp1v203xzzh0a****
DbUser	string	Yes	The database account that has the permission to terminate sessions.	testUser
DbUserPassword	string	Yes	The password of the database account.	testPassword
IgnoredUsers	string	No	The list of accounts whose sessions will not be terminated. Note The data is in JSONArray format, such as ['DatabaseAccount1','DatabaseAccount2']. Separate multiple database accounts with commas (,).	['db_user1','db_user2']
KillAllSessions	boolean	Yes	Specifies whether to terminate all sessions. true: Yes. false: No. Note When this parameter is set to true, sessions of accounts specified in the IgnoredUsers request parameter, sessions of Alibaba Cloud internal operations accounts, and Binlog Dump sessions are not terminated.	true
SessionIds	string	No	The list of session IDs to be terminated. Note The data is in JSONArray format, such as [SessionID1,SessionID2]. Separate multiple session IDs with commas (,). If the KillAllSessions request parameter is set to true (terminate all sessions), this list is ignored.	[10805639,10805623,10805645,10805553,10805566,10805616]

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
Data	string	The task ID for terminating sessions. Note When you invoke this API operation for a PolarDB for MySQL instance with the NodeId request parameter left empty (no node ID specified) and the KillAllSessions request parameter set to true (terminate all sessions), a list of task IDs is returned based on the number of nodes, such as ["f77d535b45405bd462b21caa3ee8**", "e93ab549abb081eb5dcd5396a29b**"].	f77d535b45405bd462b21caa3ee8****
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	Indicates whether the request is successful. true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": "f77d535b45405bd462b21caa3ee8****",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.