You need to enable JavaScript to run this app.
导航
数据库传输服务
  • 文档首页
    • /
  • 数据库传输服务

ModifyInstanceOrder

最近更新时间：2024.01.16 17:59:29

首次发布时间：2023.06.13 18:14:12

我的收藏

调用 ModifyInstanceOrder 接口修改任务的计费配置。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

TaskId

String

是

9863318d02ed4a6f88f14c03a2*****

任务 ID。

说明

您可以调用 DescribeTransmissionTasks 接口查询任务 ID。

OneStep

Bool

是

true

在进行计费转换时，表示在创建配置单后，是否立即创建订单并支付，取值如下：

  • true：表示创建配置单后，立即创建订单并支付。

  • false：表示创建配置单后，不创建订单支付即修改配置失败。

说明

在调用 ModifyInstanceOrder 接口修改任务的计费配置时，该参数需设置为 true。

ConvertPostPaidToPrePaid

ConvertPostPaidToPrePaid

否

{"Times": 3,"AutoRenew": true}
json

包年包月的配置信息，详细信息，请参见 ConvertPostPaidToPrePaid。

说明

在调用 ModifyInstanceOrder 接口进行按量付费转包年包月时，该参数必选。

ModifyInstanceSpec

ModifyInstanceSpecReq

否

{"TrafficSpec": "Compact"}

任务链路规格。详细信息，请参见 ModifyInstanceSpecReq。

说明

在调用 ModifyInstanceOrder 接口转换同步或订阅任务的链路规格时，该参数必选。

返回参数

名称类型 示例值描述
OrderIDListStringOrder710938814817460****订单 ID。
PreOrderIDListStringBO723708552606635****在参数 OneStep 设置为 false 时，返回的配置单 ID，表示无法进入下一步创建订单，即修改任务计费配置失败。

请求示例

POST /?Action=ModifyInstanceOrder&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host:dts.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
    "TaskId": "0c412386c4ca4ea886207ef00e*****",
    "ConvertPostPaidToPrePaid": {
        "Times": 3,
        "AutoRenew": true
    },
    "OneStep": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023032015110930FCAD0A8CC67B0EAB33",
        "Action": "ModifyInstanceOrder",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderIDList": "Order710938814817460****"
    }
}

错误码

更多详情，请参见错误码。