调用TransferPayType接口修改DTS产品的付费方式或实例规格。

请确保在使用该接口前,已充分了解云数据库DTS产品的收费方式和价格

  • 包年包月的实例无法转换为按量付费的实例,为避免您的资源浪费,在实例转换付费方式操作前确认要进行转换操作。
  • 数据迁移任务只支持按量付费,无需转换。
  • 按量付费转包年包月只是进行付费方式的切换,对于底层运行链路不会有任何影响。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数,取值:TransferPayType

ChargeType String PostPaid

修改后的付费方式,取值:

  • PrePaid:预付费,即包年包月。
  • PostPaid:后付费,即按量付费。
说明
  • 后付费实例无法转换为预付费实例,为避免您的资源浪费,在实例转换付费方式前,请确认要进行的转换操作。
  • 如无需修改付费方式,则传入当前付费方式即可。
DtsJobId String o4nh3g7jg56****

迁移、同步或订阅任务ID,可调用DescribeDtsJobs查询。

InstanceClass String large

实例规格,取值为2xlargelargemediummicrosmallxlargexmicro

说明 链路规格说明,请参见数据迁移链路规格说明数据同步链路规格说明
Period String Year

预付费实例的计费方式,取值:

  • Year:包年。
  • Month:包月。
说明ChargeTypePrePaid(预付费)时,该参数才有效且必须传入。
BuyCount String 5

预付费实例购买时长。

  • PeriodYear(包年)时,取值范围为1~5
  • PeriodMonth(包月)时,取值范围为1~60
说明ChargeTypePrepaid(预付费)时,该参数才有效且必须传入。

返回数据

名称 类型 示例值 描述
ChargeType String PostPaid

修改后的付费方式,返回值:

  • PrePaid:预付费。
  • PostPaid:后付费。
Code String 200

错误码,本参数即将下线。

DtsJobId String o4nh3g7jg56****

任务ID。

DynamicMessage String DtsJobId

动态错误信息,用于替换返回参数ErrMessage错误信息中的%s

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回DtsJobId,则代表所传入的请求参数DtsJobId不合法。
EndTime String 1614916318

预付费实例到期时间,格式为Unix时间戳。

说明
  • 如修改后的实例为后付费实例,则该值为空值。
  • Unix时间戳转换工具可用搜索引擎获取。
ErrCode String InternalError

调用错误时返回的错误码。

ErrMessage String The Value of Input Parameter %s is not valid.

调用错误时返回的错误信息。

HttpStatusCode Integer 200

状态码。

InstanceId String dtso4nh3g7jg56****

实例ID。

RequestId String 601B6F25-21E7-4484-99D5-3EF2625C****

请求ID。

Success Boolean true

请求是否成功,返回值:

  • true:请求成功。
  • false:请求失败。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=TransferPayType
&ChargeType=PostPaid
&DtsJobId=o4nh3g7jg56****
&Period=Year
&BuyCount=5
&<公共请求参数>

正常返回示例

XML格式

<TransferPayTypeResponse>
      <DtsJobId>o4nh3g7jg56****</DtsJobId>
      <RequestId>601B6F25-21E7-4484-99D5-3EF2625C****</RequestId>
      <InstanceId>dtso4nh3g7jg56****</InstanceId>
      <ChargeType>PostPaid</ChargeType>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</TransferPayTypeResponse>

JSON格式

{
  "DtsJobId": "o4nh3g7jg56****",
  "RequestId": "601B6F25-21E7-4484-99D5-3EF2625C****",
  "InstanceId": "dtso4nh3g7jg56****",
  "ChargeType": "PostPaid",
  "HttpStatusCode": 200,
  "Success": true
}

错误码

访问错误中心查看更多错误码。