调用CreateSubscriptionInstance接口购买DTS数据订阅实例。

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

调试

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

请求参数

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

系统规定参数，取值：CreateSubscriptionInstance。

Region String 是 cn-hangzhou

地域ID，与订阅对象所在地域保持一致，详情请参见支持的地域列表。

RegionId String 否 cn-hangzhou

数据订阅实例所属的地域，无需设置，该参数即将下线。
SourceEndpoint.InstanceType String 否 MySQL

数据订阅的实例类型，取值为：MySQL、PolarDB、DRDS、Oracle。

说明 默认取值为：MySQL。
PayType String 否 Prepaid

付费类型。

  • Postpaid：按量付费，默认付费类型。
  • Prepaid：预付费。
Period String 否 Month

预付费实例的计费方式，取值：

  • Year：包年。
  • Month：包月。
说明 当付费类型为Prepaid（预付费）时，该参数才有效且必须传入。
UsedTime Integer 否 12

预付费实例购买时长。

  • 当计费方式为Year（包年）时，取值范围为1~5。
  • 当计费方式为Month（包月）时，取值范围为1~60。
说明 当付费类型为Prepaid（预付费）时，该参数才有效且必须传入。
ClientToken String 否 0c593ea1-3bea-11e9-b96b-88e9fe63****

保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。

AccountId String 否 12323344****

阿里云主账号ID，无需设置，该参数即将下线。

返回数据

名称 类型 示例值 描述
ErrCode String InternalError

调用出错时返回的错误码。
ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回对应的错误信息。
RequestId String 4E9564C5-F99D-4176-A6BA-2D7F2DC8****

请求ID。
SubscriptionInstanceId String dtsfen11q2g23x****

数据订阅实例ID。
Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=CreateSubscriptionInstance
&Region=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<CreateSubscriptionInstanceResponse>
      <RequestId>4E9564C5-F99D-4176-A6BA-2D7F2DC8****</RequestId>
      <SubscriptionInstanceId>dtsfen11q2g23x****</SubscriptionInstanceId>
      <Success>true</Success>
</CreateSubscriptionInstanceResponse>

JSON格式 

{
	"RequestId": "4E9564C5-F99D-4176-A6BA-2D7F2DC8****",
	"SubscriptionInstanceId": "dtsfen11q2g23x****",
	"Success": true
}

错误码

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