暂停指定标签下所有运行中的项目

更新时间：2023-08-18 09:52:19

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

功能说明

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

调用说明

接口约束

本接口适用于 OMS 4.1.0 及以上版本。

请求路径

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":[

        ]
    }
}