DescribeInstance--消息队列 RabbitMQ版-火山引擎

文档中心

立即注册

导航

DescribeInstance

最近更新时间：2024.02.23 15:26:17首次发布时间：2021.08.30 16:33:47

调用 DescribeInstance 接口查看指定 RabbitMQ 实例的详细信息。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

使用说明

创建 RabbitMQ 实例后，您可以调用 DescribeInstance 接口查看实例的名称、网络类型等详细信息。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	rbtmq-*******	实例 ID。

响应参数

参数	参数类型	示例值	说明
InstanceId	String	rbtmq-*******	实例 ID。
InstanceName	String	test-instance	实例名称。
Description	String	description of test instance	实例的描述信息。
InstanceStatus	String	Running	实例当前的状态。包括： Creating：创建中 Running：运行中 Destroying：删除中 TaskFailed：任务执行失败 WaitingPaid：等待支付 Released：已释放 Releasing：释放中 Deleted：已释放
ComputeResource	String	rabbitmq.n1.x2.medium	计算规格。
StorageType	String	CloudSSD	实例的存储类型。
StorageCapacity	Integer	1000	实例存储空间，单位为 GiB。
UsedStorage	Integer	100	实例已使用的存储空间，单位为 GiB。
Version	RabbitMQVersion		RabbitMQ 版本。详细信息请参考RabbitMQVersion。
ArchType	String	Cluster	RabbitMQ 实例类型。 SingleNode：单机版实例。 Cluster：集群版实例。
NetTypes	List		实例的网络类型。
ChargeType	String	PrePaid	实例的计费类型。 PostPaid：按量计费。 PrePaid：包年包月。
ChargeSubType	String	Monthly	包年包月实例的购买时指定的时长单位。 Monthly：以月为单位购买。 Yearly：以年为单位购买。仅包年包月类型实例返回该参数。
OverdueTime	Integer	1645523741	包年包月实例到期时间，Unix 时间戳格式。
CreatedTime	Integer	1645523741	实例的创建时间，Unix 时间戳格式。
Endpoints	List		实例的接入点列表。详细信息请参考Endpoint。
MaintainWindow	MaintainWindow		实例的维护时间窗口期，详细信息请参考MaintainWindow。
Region	Region		实例的地域信息。详细信息请参考Region。
ChargeStatus	String	Normal	实例的计费状态。 Normal：正常收费中 Unpaid：待付款 Overdue：已过期 Expired：已释放 Reclaim：已回收
StopTime	Integer	1645523741	包年包月实例的预计关停时间，Unix 时间戳格式。仅包年包月类型实例返回该参数。
RecycleTime	Integer	1645523741	包年包月实例的预计回收时间，Unix 时间戳格式。仅包年包月类型实例返回该参数。
AutoReNew	Bool	true	报年报月实例是否自动续费。 true：自动续费 false：到期前需手动续费仅包年包月类型实例返回该参数。
ProjectName	String	test-project	实例所在的 IAM Project 名称。
Zone	Zone		实例的可用区信息。详细信息请参考Zone。
VpcId	String	test-vpc-id	VPC ID。
SubnetId	String	test-subnet-id	VPC子网 ID。
EipId	String	test-eip-id	弹性网卡 ID。
EnableTLS	Boolean	false	是否启用 SSL 认证。

示例

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeInstance&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rbtmq-*******"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "********",
    "Action": "DescribeInstance",
    "Version": "2018-01-01",
    "Service": "rabbitmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "rbtmq-*******",
    "InstanceName": "test-instance",
    "Description": "description of test instance",
    "InstanceStatus": "Running",
    "ComputeResource": "rabbitmq.n1.x2.medium",
    "StorageType": "CloudSSD",
    "StorageCapacity": 1000,
    "UsedStorage": 100,
    "Version": {
      "MajorVersion": 3,
      "MinorVersion": 8,
      "PatchVersion": 18
    },
    "ArchType": "Cluster",
    "NetTypes": [
      "Vpc"
    ],
    "ChargeType": "PrePaid",
    "ChargeSubType": "Monthly",
    "OverdueTime": 1645523741,
    "CreatedTime": 1645523741,
    "Endpoints": [
      {
        "EndpointType": "AMQP0_9_1",
        "Endpoint": "rbtmq-*******.rabbitmq.ivolces.com:5672",
        "AccessType": "Vpc"
      }
    ],
    "MaintainWindow": {
      "Day": "Monday",
      "StartHour": 10,
      "StartMinute": 0,
      "EndHour": 23,
      "EndMinute": 0
    },
    "Region": {
      "Name": "cn-beijing",
      "Description": ""
    },
    "ChargeStatus": "Normal",
    "StopTime": 1645523741,
    "RecycleTime": 1645523741,
    "AutoReNew": true,
    "ProjectName": "test-project",
    "Zone": {
      "Name": "cn-beijing-a",
      "Description": "",
      "IsSoldOut": false
    },
    "VpcId": "test-vpc-id",
    "SubnetId": "test-subnet-id",
    "EipId": "test-eip-id",
    "EnableTLS": false
  }
}