You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /
  • veImageX

删除迁移任务

最近更新时间：2024.02.19 15:03:03

首次发布时间：2023.07.14 10:25:59

我的收藏

本接口支持您通过指定任务 ID 来删除该迁移任务，仅对状态是非运行中外的任务生效。

说明

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

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Region

String

是

cn

任务地区（即任务目标服务的地区），默认空，返回国内任务。

  • cn：国内
  • sg：新加坡

TaskId

String

是

648c15f764f3c4abd95ad044

仅当任务状态为非Running时生效。
任务 ID，请参考 GetImageMigrateTasks获取返回的任务 ID。

返回参数

无

示例

请求示例

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

返回示例

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

错误码

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