You need to enable JavaScript to run this app.
导航
结束迁移任务
最近更新时间:2024.02.19 15:03:03首次发布时间:2023.07.03 19:37:52

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

说明

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

注意事项

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

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=TerminateImageMigrateTask&Version=2018-08-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

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

Query

参数类型是否必选示例值描述
ActionStringTerminateImageMigrateTask接口名称。当前 API 的名称为 TerminateImageMigrateTask
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

Region

String

cn

任务地区(即任务目标服务的地区),默认空,返回国内任务。

  • cn:国内
  • sg:新加坡
TaskIdString648c15f764f3c4abd95ad044 任务 ID,请参考 GetImageMigrateTasks 获取返回的任务 ID。

返回参数

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=TerminateImageMigrateTask&Version=2018-08-01&Region=cn&TaskId=648c15f764f3c4abd95ad044%09

返回示例

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

错误码

访问公共错误码以及通用错误码获取详细信息。