结束迁移任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

结束迁移任务

最近更新时间：2024.08.14 11:29:17首次发布时间：2024.05.06 15:18:33

通过指定任务 ID 来结束该迁移任务。结束迁移任务将停止后续的迁移文件，已完成的迁移文件不被删除。

说明

仅当状态为Initial和Running时，该结束操作有效。您可调用GetImageMigrateTasks 查看待结束任务的状态。

注意事项

请求频率限制：单用户请求频率限制为 10 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=TerminateImageMigrateTask&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`TerminateImageMigrateTask`	接口名称。当前 API 的名称为 `TerminateImageMigrateTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Region	String	否	`cn`	任务地区（即任务目标服务的地区），默认空，返回国内任务。 `cn`：国内 `sg`：新加坡
TaskId	String	是	`648c15f764f3c4abd95ad044`	任务 ID，请参考 GetImageMigrateTasks 获取返回的任务 ID。

返回参数

本接口无特有的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=TerminateImageMigrateTask&Version=2023-05-01&Region=cn&TaskId=648c15f764f3c4abd95ad044

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "TerminateImageMigrateTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 TerminateImageMigrateTask 接口文档现已停止维护，建议您参考本文档使用最新版本。