CreateInstance - 创建实例

更新时间:

创建云消息队列RabbitMQ的实例。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
amqp:CreateInstancecreate
*全部资源
*
  • amqp:InstanceType
  • amqp:SupportEIP
  • amqp:ServerlessChargeType

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token。

c2c5d1274axxxxxxxx
PaymentTypestring

付费类型,取值如下:

  • Subscription:预付费系列
  • PayAsYouGo : Serverless 系列
Subscription
Periodinteger

预付费周期,单位:periodCycle。

说明 当 PaymentType 为 Subscription 时,该参数有效,默认值为 1。
1
PeriodCyclestring

预付费周期单位,取值如下:

  • Month:月
  • Year:年

当 PaymentType 为 Subscription 时,该参数有效,默认值为 Month。

Month
AutoRenewboolean

续费方式,取值如下:

  • true:自动续费
  • false:手动续费
false
AutoRenewPeriodinteger

自动续费周期,单位 RenewalDurationUnit 值,默认为:月。

说明 当 AutoRenew 为 true 时,该参数有效,默认值为 1 。
1
RenewStatusstring

续费状态,等同于 autoRenew ,二选 1 配置即可,取值如下:

  • AutoRenewal: 自动续费
说明 和 renewStatus 都是续费方式,当两个同时填写时,以 renewStatus 为准
false
RenewalDurationUnitstring

自动续费周期单位,取值如下:

  • Month:月
  • Year:年
Month
InstanceTypestring

实例规格类型, 预付费系列的取值如下:

  • professional:专业版
  • enterprise:企业版
  • vip:铂金版

Serverless 系列实例:无需填写

professional
ServerlessChargeTypestring

Serverless 系列实例的计费类型,取值如下:

  • onDemand:按量累计
onDemand
InstanceNamestring

实例名称。建议长度不超过 64 个字符。

amqp-xxxxx
MaxPrivateTpslong

私网 TPS 流量,单位:次/秒。

请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。

1000
SupportEipboolean

是否支持公网,取值如下:

  • true:支持公网
  • false:不支持公网
true
MaxEipTpslong

公网网 TPS 流量峰值,单位:TPS。

请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。

128
QueueCapacityinteger

配置 Queue 的数量,单位:个。

请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。

1000
MaxConnectionsinteger

最大连接数。

请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。

50000
StorageSizeinteger

配置消息存储空间,单位: GB,取值如下:

  • 专业版实例和企业版实例:固定为 0。
说明 取值为 0 表示专业版和企业版实例不收取存储费用,而非没有存储空间。
  • 铂金版实例:m×100,其中 m 的取值范围为[7,28]。
7
SupportTracingboolean

是否开通消息轨迹功能,取值如下:

  • true:开通消息轨迹功能
  • false:不开通消息轨迹功能
说明
  • 铂金版实例免费提供 15 天消息轨迹功能,轨迹功能只能选择开启且轨迹保存时长只能设置为 15 天。
    • 其他规格类型实例可选择开启或关闭轨迹功能。
    true
    TracingStorageTimeinteger

    配置消息轨迹的保存时长,单位:天,取值如下:

    • 3:3 天
    • 7:7 天
    • 15:15 天

    当 SupportTracing 为 true 时,该参数有效。

    3
    ResourceGroupIdstring

    实例所属资源组 ID。

    rg-acfmvvajg5qkxhi
    EncryptedInstanceboolean

    独享实例专属功能。实例是否开通数据存储加密功能。

    false
    KmsKeyIdstring

    独享实例专属功能,当 EncryptedInstance 为 true 时需要填写此字段。 数据加密存储使用的 KMS 密钥 ID。 对密钥有以下要求:

    • 不能是服务密钥;

    • 密钥状态必须是开启的;

    • 必须是对称密钥,不能是非对称密钥;

    • 密钥用途必须是加解密;

    • KMS 密钥过期/删除后,数据读写不可用,RabbitMQ 实例异常;

    key-xxx

    返回参数

    名称类型描述示例值
    object

    JsonResult

    RequestIdstring

    公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

    CCBB1225-C392-480E-8C7F-D09AB2CD2***
    Codeinteger

    返回码。返回 200 代表成功。

    200
    Messagestring

    返回信息。

    xxx failed,xxxx
    Dataany

    返回已创建实例的 ID

    amqp-cn-xxxxx
    Successboolean

    请求是否成功。

    true

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
      "Code": 200,
      "Message": "xxx failed,xxxx",
      "Data": "amqp-cn-xxxxx",
      "Success": true
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-11-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2024-07-30OpenAPI 错误码发生变更查看变更详情
    2024-03-06API 内部配置变更,不影响调用查看变更详情
    2024-03-05OpenAPI 入参发生变更查看变更详情
    2024-02-27API 内部配置变更,不影响调用查看变更详情
    2024-02-22API 内部配置变更,不影响调用查看变更详情
    2024-01-24API 内部配置变更,不影响调用查看变更详情
    2024-01-24OpenAPI 入参发生变更查看变更详情