KillProcessList - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to close a session.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
SessionList	string	Yes	The list of the sessions that need to be closed.	[{"ServerIp":"192.168.13.119","SessionId":"3221614618"}]
TenantId	string	Yes	The ID of the tenant.	t4louaeei****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Data	object []	The data returned.
SessionId	long	The ID of the session.	1123
ServerIp	string	The IP address of the server.	127.0.0.1
Status	string	The status of the task.	SLEEP
ErrorMessage	string	The error message.	Instance not found.
ClientIp	string	The client IP address.	127.0.0.1
TenantId	string	The ID of the tenant.	t3ogqv07a56n4
User	string	The database username.	oas
Database	string	The name of the database.	test
SqlText	string	The SQL statement.	:
Command	string	The start command for the container of the application.	select 1
ExecuteTime	string	Execution time (UTC+8). If it is left empty, it means to execute immediately.	142

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": [
    {
      "SessionId": 1123,
      "ServerIp": "127.0.0.1",
      "Status": "SLEEP",
      "ErrorMessage": "Instance not found.",
      "ClientIp": "127.0.0.1",
      "TenantId": "t3ogqv07a56n4",
      "User": "oas",
      "Database": "test",
      "SqlText": ":",
      "Command": "select 1",
      "ExecuteTime": "142"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
2014	InternalError	The request processing has failed due to some unknown error.

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

Change history

Change time	Summary of changes	Operation

No change history