All Products
Search

This Product

    Database Autonomy Service:CreateKillInstanceSessionTask

    Document Center

    Database Autonomy Service:CreateKillInstanceSessionTask

    Last Updated:Apr 14, 2026

    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.

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

    • true

    • false

    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 elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    Code

    integer

    The HTTP status code returned.

    200
    Message

    string

    The returned message.

    Note

    If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.

    Successful
    Data

    string

    The ID of the task that terminated the sessions.

    Note

    If the sessions of a PolarDB for MySQL cluster were terminated, NodeId is left empty, and KillAllSessions is set to true, the task IDs are returned based on the number of nodes. Example: ["f77d535b45405bd462b21caa3ee8****", "e93ab549abb081eb5dcd5396a29b****"].

    f77d535b45405bd462b21caa3ee8****
    RequestId

    string

    The request ID.

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true

    • false

    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.
    403 NoPermission You are not authorized to do this action.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.