GetInstance - 查询实例信息

更新时间:

获取云消息队列RabbitMQ的实例。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

amqp:GetInstance

get

*Instance

acs:amqp:{#regionId}:{#accountId}:/instances/{#InstanceId}

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

云消息队列 RabbitMQ 版实例的 ID。

amqp-cn-v0h1kb9nu***

返回参数

名称

类型

描述

示例值

object

OpenApiResponse

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

92385FD2-624A-48C9-8FB5-753F2AFA***

Data

object

请求结果。

Tags

array<object>

标签列表。

object

标签信息。

Key

string

标签 key

标签key

Value

string

标签 value

标签value

Status

string

实例状态。取值如下:

  • DEPLOYING:实例部署中

  • EXPIRED:实例已过期

  • SERVING:实例服务中

  • RELEASED:实例已被释放

SERVING

SupportEIP

boolean

是否支持 EIP。

true

ExpireTime

integer

实例过期的时间戳,单位:毫秒。

说明

请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。

1651507200000

OrderCreateTime

integer

订单创建的时间戳,单位:毫秒。

说明

请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。

1651507200000

PrivateEndpoint

string

实例的 VPC 接入点。

amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com

StorageSize

integer

磁盘容量,单位:GB。

说明

专业版实例和企业版实例无此参数,返回**-1**。

200

MaxEipTps

integer

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

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

1000

InstanceId

string

消息队列 RabbitMQ 版实例的 ID。

amqp-cn-*********

InstanceType

string

实例类型。

  • PROFESSIONAL:专业版

  • ENTERPRISE:企业版

  • VIP:铂金版

  • SERVERLESS:Serverless 版

enterprise

PublicEndpoint

string

实例的公网接入点。

xxx.cn-hangzhou.xxx.net.mq.amqp.aliyuncs.com

ClassicEndpoint

string

经典接入点,该参数不再使用。

amqp-cn-st21x7kv****.not-support

MaxVhost

integer

实例的 Vhost 的数量上限,单位:个。

50

MaxTps

integer

实例的私网 TPS 流量峰值,单位:条/秒。

1000

AutoRenewInstance

boolean

是否自动续费实例。

false

InstanceName

string

需更新的实例名称。取值无限制,建议长度不超过 64 个字符。

yunQi-instance

MaxQueue

integer

实例的 Queue 的数量上限,单位:个。

1000

OrderType

string

订单类型。

  • PRE_PAID:预付费。

  • POST_PAID:后付费。

PRE_PAID

TracingStorageTime

integer

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

  • 3:3 天

  • 7:7 天

  • 15:15 天

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

15

SupportTracing

boolean

是否开通消息轨迹功能

True

MaxConnections

integer

最大连接数。

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

1500

ResourceGroupId

string

应用所属资源组 ID

rg-acfm2vn6jkayvfy

EncryptedInstance

boolean

实例数据存储是否开启存储加密

true

KmsKeyId

string

云盘对应的 KMS 密钥 ID。

key-hzz6566e86byam3lg5rw4

ProvisionedCapacity

integer

Edition

string

示例

正常返回示例

JSON格式

{
  "RequestId": "92385FD2-624A-48C9-8FB5-753F2AFA***",
  "Data": {
    "Tags": [
      {
        "Key": "标签key",
        "Value": "标签value"
      }
    ],
    "Status": "SERVING",
    "SupportEIP": true,
    "ExpireTime": 1651507200000,
    "OrderCreateTime": 1651507200000,
    "PrivateEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com\n",
    "StorageSize": 200,
    "MaxEipTps": 1000,
    "InstanceId": "amqp-cn-*********",
    "InstanceType": "enterprise",
    "PublicEndpoint": "xxx.cn-hangzhou.xxx.net.mq.amqp.aliyuncs.com",
    "ClassicEndpoint": "amqp-cn-st21x7kv****.not-support\n",
    "MaxVhost": 50,
    "MaxTps": 1000,
    "AutoRenewInstance": false,
    "InstanceName": "yunQi-instance",
    "MaxQueue": 1000,
    "OrderType": "PRE_PAID",
    "TracingStorageTime": 15,
    "SupportTracing": true,
    "MaxConnections": 1500,
    "ResourceGroupId": "rg-acfm2vn6jkayvfy",
    "EncryptedInstance": true,
    "KmsKeyId": "key-hzz6566e86byam3lg5rw4",
    "ProvisionedCapacity": 0,
    "Edition": ""
  }
}

错误码

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

变更历史

更多信息,参考变更详情