文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 删除StarRocks数据同步- DeleteStarRocksDataReplication
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

删除StarRocks数据同步 - DeleteStarRocksDataReplication

功能介绍

删除StarRocks数据同步。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:deleteDataSync

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:htapInstance:deleteDataSync

    -

URI

DELETE /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

StarRocks实例ID，严格匹配UUID规则。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为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参数

参数

是否必选

参数类型

描述

task_name

否

String

参数解释：

数据同步任务名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

取值范围：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

删除同步任务工作ID。

取值范围：

不涉及。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication

{
  "task_name" : "task_name"
}

响应示例

状态码： 200

Success.

{
  "job_id" : "123"
}

状态码： 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版