结束会话
接口约束
仅支持包含有CN或DN(主、备)组件的节点。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/instances/{instance_id}/kill-session
| 名称 | 是否必选 | 说明 | 
|---|---|---|
| project_id | 是 | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 | 
| instance_id | 是 | 参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| X-Language | 否 | String | 参数解释: 语言。 约束限制: 不涉及。 取值范围: 
 默认取值: en-us。 | 
| 名称 | 是否必选 | 参数类型 | 说明 | 
|---|---|---|---|
| node_id | 是 | String | 参数解释: 节点ID。 约束限制: 仅支持包含有CN或DN(主、备)组件的节点。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| component_id | 是 | String | 参数解释: 组件ID。 约束限制: 仅支持包含有CN或DN(主、备)组件ID,且需要是node_id参数上的组件。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| session_ids | 是 | Array of strings | 参数解释: 查杀指定会话ID列表。 约束限制: 不涉及。 | 
| instance_id | 否 | String | 参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 | 
响应参数
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| session_ids | Array of strings | 参数解释: 成功查杀指定会话ID列表。 | 
| success | Boolean | 参数解释: 是否成功。 取值范围: 
 | 
请求示例
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/kill-session
{
	"node_id": "52c25e148a4a48c293b66ca95565719cno14",
	"component_id": "cn_5001",
	"session_ids": ["10180"]
}
 响应示例
{ 
  "session_ids" : [ "10180" ], 
  "success" : true 
}
 状态码
- 正常
- 异常
    请参见状态码。 
错误码
请参见错误码。
 
    