关闭全量SQL
功能介绍
关闭全量SQL功能。关闭后,实例Agent侧将停止内核侧全量SQL语句记录的实时采集。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/instances/{instance_id}/full-sql/stop
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us。 |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
请求示例
关闭全量SQL。
POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/cf9c879513144362bce2b3760ed81d3bin14/full-sqls/stops
响应示例
{ "job_id":"4cf79c7f-63a6-4db4-b606-e8c6448d67cb" }
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。