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

使用说明

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

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeInstanceDetail

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

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

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

InstanceId string 必选示例值：rocketmq-cnai1f0c29ca****

待查询详情的实例 ID。

返回参数

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

BasicInfo object 示例值：/

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

InstanceId string 示例值：rocketmq-cnai1f0c29ca****

实例 ID。

InstanceName string 示例值：newnstance

实例名称。

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

实例的简单描述。

InstanceStatus string 示例值：Running

实例状态。

RegionId string 示例值：cn-shanghai

实例所在的地域 ID。

ZoneId string 示例值：cn-guangzhou-a

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

Version string 示例值：4.8

支持的 RocketMQ 版本。当前支持 4.8 版本，即兼容 RocketMQ 4.x 版本系列。

UsedTopicNumber integer 示例值：20

当前实例已创建的 Topic 个数。

ComputeSpec string 示例值：rocketmq.n1.x2.small

实例的计算规格。

CreateTime string 示例值：2022-07-18T07:48:58Z

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

UsedStorageSpace integer 示例值：100

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

StorageSpace integer 示例值：200

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

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

私有网络（VPC） ID。

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

VPC 的子网 ID。

EnableSSL boolean 示例值：false

实例是否已开启 SSL 认证。

开启实例的公网访问后，默认开启 SSL 认证。如果 SSLMode 设置为 permissive，则可以按需选择是否经由 SSL 认证。

FileReservedTime integer 示例值：72

消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时。

ProjectName string 示例值：newproject

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

AccountId string 示例值：200000****

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

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

EIP 的 ID。

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

SSLMode string 示例值：permissive

实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：

enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。

permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。

AvailableQueueNumber integer 示例值：3944

剩余可创建的分区数量。

UsedQueueNumber integer 示例值：1

实例已经使用的队列数。

UsedGroupNumber integer 示例值：20

当前实例已经创建的消费组（Group）个数。

ChargeDetail object 示例值：/

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

ChargeType string 示例值：PostPaid

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

PostPaid ：按量付费

PrePaid：包年包月

AutoRenew boolean 示例值：true

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

true：自动续费。

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

ChargeStatus string 示例值：Normal

实例的计费状态。包括：

Normal：正常

Overdue：按量计费欠费

Expired：包年包月到期

ChargeStartTime string 示例值：2022-07-18T07:48:58Z

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

ChargeExpireTime string 示例值：2022-07-18T07:48:58Z

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

按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。

OverdueTime string 示例值：2022-07-18T07:48:58Z

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

OverdueReclaimTime string 示例值：2022-07-18T07:48:58Z

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

PeriodUnit string 示例值：Monthly

包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：

Monthly：（默认）包月

Yearly：包年

ApplyPrivateDNSToPublic boolean 示例值：true

是否已开启私网域名支持公网解析功能。

true：已开启

false：已关闭

InstanceTags object[] 示例值：/

实例绑定的标签。

Key string 示例值：owner

标签的键。

Value string 示例值：zhangsan

标签的值。

AvailableTopicNumber integer 示例值：1

可用主题数量

TotalTps integer 示例值：2000

当前实例支持的最大 TPS 总量

AvailableGroupNumber integer 示例值：1

可用消费组数量

ProductVersion string 示例值：basic

5.x 版本实例的产品类型，分为基础版和专业版。

basic：基础版

professional：专业版

SendReceiveRatio integer 示例值：99

发送和接收消息的限流比例，5.x 版本实例专用

EnableInspect boolean 示例值：true

是否开启实例巡检。

true：开启

false：关闭

FileReservedTime integer 示例值：72

消息保留时长。

ConnectionInfo object[] 示例值：/

实例的连接信息。

EndpointType string 示例值：TCP

实例的接入点类型。

NetworkType string 示例值：PrivateNetwork

实例接入点的网络类型。

InternalEndpoint string 示例值：http://rocketmq-cnai1f0c29ca****.rocketmq.ivolces.com:9876

实例的私网接入点地址。

PublicEndpoint string 示例值：http://rocketmq-cnai1f0c29ca****.rocketmq.volces.com:9876

实例的公网接入点地址。

EndpointAddressIP string 示例值：/

实例的接入点 IP 地址。