All Products
Search
Document Center

ApsaraDB for OceanBase:BatchKillProcessList

Last Updated:Sep 12, 2024

You can call this operation to close sessions in batches. Please note that this operation is executed asynchronously. After calling this operation, you need to verify it by calling DescribeProcessStatsComposition.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
SessionListstringYes

The list of sessions to close.

[{"ProxySessId":"752113700739156671","SessionId":3221555062,"ServerIp":"10.***.**.***"}]
TenantIdstringYes

The ID of the tenant.

t33h8y08k****

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Dataarray<object>

The array of the return result.

object

The return result.

Successboolean

Indicates whether the calling is successful.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": [
    {
      "Success": true
    }
  ]
}

Error codes

HTTP status codeError codeError message
2014InternalErrorThe request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.