文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ SQL限流/ 同步SQL限流任务
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

同步SQL限流任务

功能介绍

从内核侧同步实例的SQL限流任务到管控侧。

调试

您可以在API Explorer中调试该接口。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/sync-limit-task

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

语言。

缺省值：en-us

枚举值：

  • zh-cn
  • en-us

响应参数

表3 响应Body参数

参数

参数类型

描述

result

String

同步结果，success成功，fail失败。

instance_id

String

同步数据的实例ID。

node_id

String

同步数据的节点ID，集中式表示主节点ID，分布式表示CN节点ID。

total_count

Integer

同步的数据记录总数。

请求示例

https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/sync-limit-task
{
}

响应示例

{
    "result": "success",
    "instance_id": "ee95e4fd433d44a9b6dfa788149c8dd7in14",
    "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14",
    "total_count": 3
}

状态码

错误码

请参见错误码。

父主题： SQL限流

相关文档