機能の概要
指定されたテナントのセッションプロセスを一括で終了します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/sessions/batchKill
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OceanBase CloudインスタンスID |
| tenantId | String | はい | テナントID |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| sessionList | String | はい | セッションリスト。JSON形式の文字列 | "[{\"ProxySessId\":\"xxxxx\",\"SessionId\":xxxx,\"ServerIp\":\"xx.xxx.xx.xxx\"}]" |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| RequestId | String | リクエストID |
| Data | Array<Object> |
実行結果の配列 |
| Data[].Success | Boolean | 呼び出しが成功したかどうか |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X POST \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/sessions/batchKill?requestId={requestId}' \
-H 'Content-Type: application/json' \
--data '{"sessionList":"[{\"ProxySessId\":\"752113700739156671\",\"SessionId\":3221555062,\"ServerIp\":\"xxx.xxx.x.xxx:xxxx\"}]"}'
レスポンス例
JSON 形式
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"Data": [
{
"Success": true
}
]
}