暂停指定标签下所有运行中的任务

更新时间：2026-04-14 15:40:47

编辑

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：暂停指定标签下所有运行中的任务 StopProjectsByLabel。

功能说明

本接口用于暂停指定标签下，所有处于运行中状态的数据迁移或数据同步任务。

调用说明

接口约束

本接口适用于 OMS 社区版 V4.1.1-CE 及之后版本。

请求路径

POST /api/v2?Action=StopProjectsByLabel

请求参数

参数	类型	描述
id	string	标签 ID。

返回结果

参数	类型	描述
success	boolean	是否调用成功。
errorDetail	object	错误详情。
code	string	错误码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer	页序号，分页查询时生效。
pageSize	integer	页大小，分页查询时生效。
totalCount	integer	总数，分页查询时生效。
cost	string	请求耗时，单位为秒。
data	string	任务的相关信息。
├─ total	integer	执行的总任务数。
├─ succeedProjectIds	string	执行的成功的任务的 ID。
├─ failedProjectIds	string	执行失败的任务的 ID。

示例

请求示例

{
    "id":"l_****"
}

返回示例

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"a7b57****",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"27 ms",
    "data":{
        "total":null,
        "succeedProjectIds":[

        ],
        "failedProjectIds":[

        ]
    }
}