文档首页/ 云数据库 TaurusDB/ API参考/ API/ 智能诊断/ 添加自动Kill会话任务 - AddKillProcessTask
更新时间:2026-11-10 GMT+08:00
分享

添加自动Kill会话任务 - AddKillProcessTask

功能介绍

添加自动Kill会话任务。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:modify

    Permission_management

    -

    -

    gaussdb:instance:modify

    -

URI

POST /v3/{project_id}/instances/{instance_id}/process/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID,此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

否

String

参数解释:

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英文。

  • zh-cn:中文。

默认取值:

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

user

否

String

参数解释:

用户名。

约束限制:

不涉及。

取值范围:

1到32个字符之间,由字母、数字、中划线或下划线组成,不能包含其他特殊字符。

默认取值:

不涉及。

host

否

String

参数解释:

主机。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

db

否

String

参数解释:

数据库名。

约束限制:

不涉及。

取值范围:

1到64个字符之间,由字母、数字、中划线或下划线组成,不能包含其他特殊字符。

默认取值:

不涉及。

command

否

String

参数解释:

命令。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

info

否

String

参数解释:

SQL语句。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

time

是

String

参数解释:

持续时间,单位为秒。持续时间大于等于该值的会话满足Kill条件。

约束限制:

必须是整数。

取值范围:

1-2147483647。

默认取值:

不涉及。

end_time

否

String

参数解释:

任务持续时间,单位为秒。

约束限制:

执行方式为auto时必填。

取值范围:

10-31535999。

默认取值:

不涉及。

mode

是

String

参数解释:

执行方式。

约束限制:

不涉及。

取值范围:

  • auto:定时关闭,任务持续时长等于end_time参数值。

  • manual:手动关闭。

默认取值:

不涉及。

响应参数

状态码:200

无

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

添加定时关闭的Kill会话任务。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/5eb47562e4b643f38d15c3bbea3e8fabin07/process/task

{
  "user" : "root",
  "host" : "192.168.0.0",
  "db" : "database1",
  "command" : "Query",
  "time" : "10",
  "end_time" : "15",
  "mode" : "auto"
}

响应示例

状态码:200

{ }

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

相关文档