文档

CreateInstance - 创建实例

更新时间:
一键部署

调用CreateInstance接口创建云消息队列 RocketMQ 版5.0实例。调用本接口会创建一个新购实例资源的订单,并自动支付。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

CreateInstance

系统规定参数。取值:CreateInstance

Parameter.N.Code

String

InstanceType

第N个模块属性Code配置,如有多个模块属性参数,按照N=0,1,2,3…N的形式拼接多个参数。

该参数需与Parameter.N.Value一起使用。

云消息队列 RocketMQ 版创建实例还需要配置更多属性,请参见配置Parameter.N.Code参数

Parameter.N.Value

String

professional

第N个模块属性Code对应的Value,如有多个模块属性参数,按照N=0,1,2,3…N的形式拼接多个参数。

ProductCode

String

ons

产品代码,固定为:ons。

ProductType

String

ons_rmqsub_public_cn

产品类型,固定为:ons_rmqsub_public_cn。

SubscriptionType

String

Subscription

付费类型,取值如下:

  • Subscription:预付费

使用本接口创建云消息队列 RocketMQ 版5.0实例,该参数只能取值为Subscription。

RenewalStatus

String

AutoRenewal

续费方式,取值如下:

  • AutoRenewal:自动续费

  • ManualRenewal:手动续费

RenewPeriod

Integer

1

自动续费周期, 单位:月。

说明

RenewalStatus取值为AutoRenewal时,该参数必须设置。

Period

Integer

1

预付费周期,单位:月。按年付费产品请输入12的整数倍。

Logistics

String

不涉及

物流信息。创建云消息队列 RocketMQ 版实例时不涉及,您无需填写该参数。

ClientToken

String

JASIOFKVNVIXXXXXX

客户端幂等参数,服务端会查询是否有相同ClientToken的请求,如果有,直接返回上次调用结果。

表 1. 配置Parameter.N.Code参数

参数

取值

是否必选

描述

Parameter.0.Code

internet_spec

配置是否为实例是否开启公网访问功能。

Parameter.0.Value取值如下:

  • disable:关闭公网,实例仅支持通过VPC内网访问。

  • enable:开启公网,实例同时支持VPC内网访问和公网访问。

若开启公网访问,云消息队列 RocketMQ 版会收取公网下行带宽费用。具体计费信息,请参见公网访问费用

Parameter.1.Code

flow_out_type

配置公网计费类型。

Parameter.1.Value取值如下:

  • uninvolved:不涉及。当Parameter.0.Value取值为disable,即不开启公网,Parameter.1.Value需要配置为uninvolved。

  • payByBandwidth:固定带宽计费。当Parameter.0.Value取值为enable,即开启公网,Parameter.1.Value需要配置为payByBandwidth。

Parameter.2.Code

flow_out_bandwidth

配置公网带宽。Parameter.1.Value取值为payByBandwidth时必须配置。

Parameter.2.Value取值范围为[1,1000],单位:Mbps。

Parameter.3.Code

region

配置实例所属地域。Parameter.3.Value取值为实例所支持的地域ID,例如cn-shenzhen。各地域所对应的RegionID,请参见开服地域

Parameter.4.Code

instance_version

配置实例版本。

Parameter.4.Value固定取值:rocketmq5.0。

Parameter.5.Code

vpc_id

配置实例所绑定的VPC。

Parameter.5.Value取值为已创建的VPC的ID,例如:vpc-**1u0bwhyb586i7axgs**。

选择的VPC实例和待创建的云消息队列 RocketMQ 版实例需要处于同一地域。

Parameter.6.Code

vswitch_id

配置实例所绑定的Vswitch。

Parameter.6.Value取值为已选择的VPC下的Switch的ID。例如:vsw-***bdohgpe5atvjbu***。

Parameter.7.Code

series_type

配置实例的主系列。

Parameter.7.Value取值如下:

  • standard:标准版

  • professional:专业版

  • ultimate:铂金版

实例规格差异,请参见实例规格

Parameter.8.Code

sub_series_type

配置实例的子系列。

Parameter.8.Value取值如下:

  • cluster_ha:集群高可用版(生产环境推荐)

  • single_node:单节点版(环境专用)

Parameter.9.Code

msg_process_spec

配置云消息队列 RocketMQ 版实例的计算规格。

Parameter.9.Value取值请参见实例规格上限中的实例规格列。例如:rmq.s2.2xlarge。

重要

填写的实例规格必须是所选择的主系列和子系列下所支持的规格。

Parameter.10.Code

order_num

配置需要创建的实例数量。

Parameter.10.Value取值范围为

[1,9999],单位:个。

Parameter.11.Code

ord_time

配置实例的购买时长。

Parameter.11.Value取值范围为[1,36]的整数,单位:月。

返回数据

名称

类型

示例值

描述

Code

String

Success

状态码。

Data

Struct

返回信息。

InstanceId

String

rmq-cn-wny3psj****

订单对应的实例ID。

OrderId

String

21014976059****

创建成功的订单ID。

Message

String

Successful!

提示信息。

RequestId

String

B62C712B-1789-5114-B0BB-80CB2AFD****

请求ID。

Success

Boolean

true

是否成功。

示例

请求示例

http(s)://business.aliyuncs.com/?Action=CreateInstance

&Parameter.0.Code=internet_spec

&Parameter.0.Value=enable

&Parameter.1.Code=flow_out_type

&Parameter.1.Value=payByBandwidth

&Parameter.2.Code=flow_out_bandwidth

&Parameter.2.Value=30
&Parameter.3.Code=region

&Parameter.3.Value=cn-shenzhen

&Parameter.4.Code=instance_version

&Parameter.4.Value=rocketmq5.0

&Parameter.5.Code=vpc_id

&Parameter.5.Value=vpc-**1u0bwhyb586i7axgs**

&Parameter.6.Code=vswitch_id

&Parameter.6.Value=vsw-***bdohgpe5atvjbu***

&Parameter.7.Code=series_type

&Parameter.7.Value=standard
&Parameter.8.Code=sub_series_type

&Parameter.8.Value=single_node

&Parameter.9.Code=msg_process_spec

&Parameter.9.Value=rmq.s1.micro

&Parameter.10.Code=order_num
&Parameter.10.Value=1

&Parameter.11.Code=ord_time

&Parameter.11.Value=1

&ProductCode=ons

&ProductType=ons_rmqsub_public_cn

&SubscriptionType=Subscription

&Period=1

&RenewPeriod=1

&RenewalStatus=AutoRenewal

&<公共请求参数>

正常返回示例

XML 格式

<CreateInstanceResponse>
      <RequestId>B62C712B-1789-5114-B0BB-80CB2AFD****</RequestId>
      <Message>Successful!</Message>
      <Data>
            <InstanceId>rmq-cn-wny3p***</InstanceId>
            <OrderId>21014976059****</OrderId>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</CreateInstanceResponse>

JSON 格式

{
  "RequestId": "B62C712B-1789-5114-B0BB-80CB2AFD****",
  "Message": "Successful!",
  "Data": {
    "InstanceId": "rmq-cn-wny3p***",
    "OrderId": 21014976059****
  },
  "Code": "Success",
  "Success": true
}

错误码

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

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