ModifyInstanceOrder--数据库传输服务-火山引擎

文档中心

立即注册

导航

数据库传输服务

ModifyInstanceOrder

最近更新时间：2024.09.10 11:40:10首次发布时间：2023.06.13 18:14:12

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

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
TaskId	String	是	9863318d02ed4a6f88f14c03a2*****	任务 ID。说明您可以调用 DescribeTransmissionTasks 接口查询任务 ID。
OneStep	Boolean	是	true	在进行计费转换时，表示在创建配置单后，是否立即创建订单并支付，取值如下： `true`：表示创建配置单后，立即创建订单并支付。 `false`：表示创建配置单后，不创建订单支付即修改配置失败。说明在调用 `ModifyInstanceOrder` 接口修改任务的计费配置时，该参数需设置为 `true`。
ConvertPostPaidToPrePaid	Object	否	`{ "Times": 3, "AutoRenew": true }`	包年包月的配置信息。说明在调用 ModifyInstanceOrder 接口进行按量付费转包年包月时，该参数必选。
ModifyInstanceSpec	Object	否	`{ "TrafficSpec": "Compact" }`	任务链路规格。说明在调用 ModifyInstanceOrder 接口转换同步或订阅任务的链路规格时，该参数必选。

返回参数

参数	类型	示例值	描述
OrderIDList	String[]	Order710938814817460****	订单 ID。
PreOrderIDList	String[]	BO723708552606635****	在参数 `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": {
        "Action": "ModifyInstanceOrder",
        "Region": "cn-north-1",
        "Service": "dts",
        "Version": "2022-10-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "OrderIDList": [
            "Order710938814817460****"
        ]
    }
}

错误码

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