调用 DescribeInstanceDetail 接口查看指定实例的详情。

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeInstanceDetail

要执行的操作，取值：DescribeInstanceDetail。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

InstanceId string 必选示例值：rbtmq-5b293870****

待查询详情的 RabbitMQ 实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

BasicInstanceInfo object 示例值：/

实例的名称、版本等基本信息。

InstanceDescription string 示例值：这是一个测试实例

实例的简单描述。

InstanceStatus string 示例值：Running

实例状态。

InstanceName string 示例值：RabbitMQinstance

RabbitMQ 实例名称。

UsedStorageSpace integer 示例值：100

实例已用储空间。单位为 GiB。

StorageSpace integer 示例值：200

实例总存储空间，单位为 GiB。

InstanceId string 示例值：rabbitmq-cnngqkfgdudt****

RabbitMQ 实例 ID。

RegionId string 示例值：cn-guangzhou

实例所在的地域 ID。

Version string 示例值：3.8.18

支持的 RabbitMQ 版本。当前支持的版本包括：

3.8.18：RabbitMQ 3.8.18 版本。

ZoneId string 示例值：cn-guangzhou-a

实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

RegionDescription string 示例值：华南1（广州）

地域的描述信息。

ApplyPrivateDNSToPublic boolean 示例值：true

是否已开启公网解析功能。

true：已开启

false：已关闭

ChargeDetail object 示例值：/

实例的计费方式等计费信息。

ChargeType string 示例值：PostPaid

实例的计费类型。支持的类型包括：

PostPaid ：按量付费

PrePaid：包年包月

ChargeStatus string 示例值：Normal

实例的计费状态。包括：

Normal：正常

Overdue：按量计费欠费

Expired：包年包月到期

ChargeStartTime string 示例值：2022-01-02T15:04:05Z07:00

实例的开始计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

OverdueReclaimTime string 示例值：2022-01-02T15:04:05Z07:00

实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

OverdueTime string 示例值：2022-01-02T15:04:05Z07:00

实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

ChargeExpireTime string 示例值：2022-01-02T15:04:05Z07:00

包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

说明

仅包年包月实例返回此参数。

AutoRenew boolean 示例值：true

包年包月实例到期后是否自动续费。

true：自动续费。

false：不自动续费。到期后需要手动续费，否则实例将被关停。

ChargeEndTime string 示例值：2022-01-02T15:04:05Z07:00

实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

ArchType string 示例值：Cluster

实例的类型，即集群版或单机版。

IsEncrypted boolean 示例值：false

是否开启了云盘加密。

云盘加密为邀测功能，如需使用，请联系技术支持申请白名单。

仅 DescribeInstanceDetail 接口返回此字段。

InitUserName string 示例值：Admin

RabbitMQ WebUI 管理员账号名。

EipId string 示例值：eip-mjhulvqza6805smt1bnc****

EIP 的 ID。如果实例未开启公网访问方式，则不返回此参数。

ComputeSpec string 示例值：rabbitmq.n3.x2.medium

RabbitMQ 实例的计算规格。

可以通过 DescribeComputeSpecsInfo 接口查询指定可用区售卖中的计算规格。

ProjectName string 示例值：newproject

实例所属的 IAM 项目。如果实例不属于任何 IAM 项目，则不返回此参数。

AccountId string 示例值：20000

创建实例的火山引擎主账号 ID。

ZoneDescription string 示例值：华南1（广州）-可用区B

可用区的描述信息

VpcId string 示例值：vpc-13fo9gkz6j6683n6nu5ec****

私有网络（VPC） ID。

SubnetId string 示例值：subnet-min6uy01kuf45smt1a2i****

VPC 的子网 ID。

CreateTime string 示例值：1654485759

实例的创建时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。

Tags object[] 示例值：/

实例绑定的标签。

Key string 示例值：owner

标签的键。

Value string 示例值：zhangsan

标签的值。

Endpoints object[] 示例值：/

实例的连接信息。

EndpointType string 示例值：WEB

实例的接入点类型。关于接入点的详细说明请参考查看接入点。

RabbitMQ实例提供的接入点类型包括：

WEB：Web UI 接入点

AMQP0_9_1：AMQP 接入点

MQTT：MQTT接入点

WEB_MQTT：WEB MQTT 接入点

STOMP：STOMP 接入点

NetworkType string 示例值：PrivateNetwork

接入点的网络类型。PrivateNetwork 表示私有网络 VPC。

InternalEndpoint string 示例值：rbtmq-322db6ab****.rabbitmq.ivolces.com:5672

实例的私网访问域名。

PublicEndpoint string 示例值：rbtmq-322db6ab****.rabbitmq.volces.com:5671

实例公网访问域名。仅在开启公网访问之后显示。

InternalIpEndpoint string 示例值：10.249.15.63:5672

公共服务区 IP 接入点。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	CheckOwnerError	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
404	InstanceNotExist	The specified Instance ID does not exist.	指定的实例不存在
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。

消息队列 RabbitMQ版