调用 DescribeInstance 接口，查询目标 BMQ 实例详情。

请求说明

请求方式：GET

请求地址：https://open.volcengineapi.com?Action=DescribeInstance&Version=2023-06-01

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeInstance

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

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

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

ProjectName string 可选示例值：default

实例所属项目名称。

InstanceId string 可选示例值：o-00c0****m46c

根据实例 ID 查询实例。

说明

如果不使用 TopicId 查询 Topic，ProjectId 和 Name 需要同时填写。

Name string 可选示例值：bmq-test

根据实例名称查询实例。

返回参数

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

Name string 示例值：bmq-test

实例名称。

Tags object[] 示例值：\-

实例资源标签列表。

Key string 示例值：user

标签键。

Type string 示例值：CUSTOM

实例标签的类型，取值如下：

CUSTOM：自定义设置标签。

SYSTEM：系统标签。

Value string 示例值：doc

标签值。

VpcId string 示例值：vpc-mj1u****3o5c5smt1bs88jem

实例所在 VPC ID。

Status string 示例值：RUNNING

实例的状态。

RegionId string 示例值：cn-beijing

实例所属地域。

Endpoints object 示例值：\-

实例所有接入点响应数据。

Public object 示例值：\-

实例公网访问接入点响应数据。

Ssl string 示例值：o-00c0****m46c.bmq-dev.ivolces.com

加密接入点。

私网 SSL 协议接入点：o-00c0****m46c.bmq-dev.ivolces.com。

公网接入点：o-00c0*****m46c-cn-beijing.bmq.volces.com。

Sasl string 示例值：o-00c0****m46c.bmq-dev.ivolces.com

私网 SASL 认证接入点。

EipId string 示例值：eip-mixfa****5xc5smt1axs1d7m

实例绑定的 EIP 的 ID。

Plain string 示例值：o-00c0****m46c.bmq-dev.ivolces.com

私网 Plain 接入点。

Status string 示例值：ENABLED

接入点状态。

VpcIds string[] 示例值：["vpc-mj1u****3o5c5smt1bs88jem"]

售卖区网络关联的 VPC ID 列表。

Address string 示例值：192.168.**.\**

域名映射地址。

SslPort integer 示例值：9094

加密接入点端口。

私网 SSL 协议接入点端口：9094。

公网接入点端口：9194。

SaslPort integer 示例值：9093

认证接入点端口。

PlainPort integer 示例值：9092

普通接入点端口。

Overlay object 示例值：\-

实例私网访问接入点响应数据。

Ssl string 示例值：o-00c0****m46c.bmq-dev.ivolces.com

加密接入点。

私网 SSL 协议接入点：o-00c0****m46c.bmq-dev.ivolces.com。

公网接入点：o-00c0*****m46c-cn-beijing.bmq.volces.com。

Sasl string 示例值：o-00c0****m46c.bmq-dev.ivolces.com

私网 SASL 认证接入点。

EipId string 示例值：eip-mixfa****5xc5smt1axs1d7m

实例绑定的 EIP 的 ID。

Plain string 示例值：o-00c0****m46c.bmq-dev.ivolces.com

私网 Plain 接入点。

Status string 示例值：ENABLED

接入点状态。

VpcIds string[] 示例值：["vpc-mj1u****3o5c5smt1bs88jem"]

售卖区网络关联的 VPC ID 列表。

Address string 示例值：192.168.**.\**

域名映射地址。

SslPort integer 示例值：9094

加密接入点端口。

私网 SSL 协议接入点端口：9094。

公网接入点端口：9194。

SaslPort integer 示例值：9093

认证接入点端口。

PlainPort integer 示例值：9092

普通接入点端口。

Resources object 示例值：\-

实例资源统计响应数据。

Storage object 示例值：\-

资源统计响应数据。

Size long 示例值：3160577

资源大小。

Unit string 示例值：B

资源单位。

CreateTime string 示例值：2024-12-05T14:00:00

实例的创建时间。

GroupLimit integer 示例值：800

实例消费组数量上限。

InstanceId string 示例值：o-00c0****m46c

实例 ID。

TopicLimit integer 示例值：400

实例 Topic 数量上限。

ZoneIdList string[] 示例值：["cn-beijing-c"]

实例所在可用区列表。

BillingType string 示例值：MIX

实例的计费方式，取值如下：

POST：按量计费。

MIX：包年包月。

Description string 示例值：测试使用

实例的描述语句。

ProjectName string 示例值：default

实例所属项目名称。

ResourceTags object[] 示例值：\-

实例资源标签列表。

Type string 示例值：CUSTOM

标签类型，取值如下：

CUSTOM：自定义设置标签。

SYSTEM：系统标签。

TagKvs object 示例值：{ "Type": "CUSTOM", "TagKvs": {"user": "doc"} }

标签键值对。

SubnetIdList string[] 示例值：["subnet-13f59****p69s3n6nu58jcb7b"]

实例使用的子网列表。

Specification string 示例值：bmq.xlarge

实例规格。

如需详细了解实例规格，请参见实例规格。

ExpirationTime string 示例值：2025-12-05T23:59:59

实例过期时间。

PartitionLimit integer 示例值：400

实例分区数量上限。

MessageRetention integer 示例值：72

实例下所有 Topic 的消息保留时长，单位为小时。

SecurityGroupIdList string[] 示例值：["g-mj1u****fu2o5smt1aem4ps4"]

实例使用安全组列表。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

云原生消息引擎