创建云消息队列RabbitMQ的实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
amqp:CreateInstance | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token。 | c2c5d1274axxxxxxxx |
PaymentType | string | 是 | 付费类型,取值如下:
| Subscription |
Period | integer | 否 | 预付费周期,单位:periodCycle。 说明
当 PaymentType 为 Subscription 时,该参数有效,默认值为 1。
| 1 |
PeriodCycle | string | 否 | 预付费周期单位,取值如下:
当 PaymentType 为 Subscription 时,该参数有效,默认值为 Month。 | Month |
AutoRenew | boolean | 否 | 续费方式,取值如下:
| false |
AutoRenewPeriod | integer | 否 | 自动续费周期,单位 RenewalDurationUnit 值,默认为:月。 说明
当 AutoRenew 为 true 时,该参数有效,默认值为 1 。
| 1 |
RenewStatus | string | 否 | 续费状态,等同于 autoRenew ,二选 1 配置即可,取值如下:
说明
和 renewStatus 都是续费方式,当两个同时填写时,以 renewStatus 为准
| false |
RenewalDurationUnit | string | 否 | 自动续费周期单位,取值如下:
| Month |
InstanceType | string | 否 | 实例规格类型, 预付费系列的取值如下:
Serverless 系列实例:无需填写 | professional |
ServerlessChargeType | string | 否 | Serverless 系列实例的计费类型,取值如下:
| onDemand |
InstanceName | string | 否 | 实例名称。建议长度不超过 64 个字符。 | amqp-xxxxx |
MaxPrivateTps | long | 否 | 私网 TPS 流量,单位:次/秒。 请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。 | 1000 |
SupportEip | boolean | 否 | 是否支持公网,取值如下:
| true |
MaxEipTps | long | 否 | 公网网 TPS 流量峰值,单位:TPS。 请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。 | 128 |
QueueCapacity | integer | 否 | 配置 Queue 的数量,单位:个。 请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。 | 1000 |
MaxConnections | integer | 否 | 最大连接数。 请根据 “云消息队列 RabbitMQ 版-购买页” 所给出的取值设置。 | 50000 |
StorageSize | integer | 否 | 配置消息存储空间,单位: GB,取值如下:
说明
取值为 0 表示专业版和企业版实例不收取存储费用,而非没有存储空间。
| 7 |
SupportTracing | boolean | 否 | 是否开通消息轨迹功能,取值如下:
说明
| true |
TracingStorageTime | integer | 否 | 配置消息轨迹的保存时长,单位:天,取值如下:
当 SupportTracing 为 true 时,该参数有效。 | 3 |
ResourceGroupId | string | 否 | 实例所属资源组 ID。 | rg-acfmvvajg5qkxhi |
EncryptedInstance | boolean | 否 | 独享实例专属功能。实例是否开通数据存储加密功能。 | false |
KmsKeyId | string | 否 | 独享实例专属功能,当 EncryptedInstance 为 true 时需要填写此字段。 数据加密存储使用的 KMS 密钥 ID。 对密钥有以下要求:
| key-xxx |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
"Code": 200,
"Message": "xxx failed,xxxx",
"Data": "amqp-cn-xxxxx",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-05 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-11-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-07-30 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-03-06 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-03-05 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-02-27 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-02-22 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-24 | OpenAPI 入参发生变更 | 查看变更详情 |