文档首页> 分布式消息服务RocketMQ版> API参考（阿布扎比区域）> API V2（推荐）> 生命周期管理> 查询指定实例
更新时间：2023-05-06 GMT+08:00
查看PDF

查询指定实例

功能介绍

查询指定实例的详细信息。

URI

GET /v2/{project_id}/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

name

String

实例名称。

engine

String

引擎。

status

String

状态。

description

String

消息描述。

type

String

实例类型：集群，cluster。

specification

String

实例规格。

engine_version

String

版本。

instance_id

String

实例ID。

charging_mode

Integer

付费模式，1表示按需计费。

vpc_id

String

私有云ID。

vpc_name

String

私有云名称。

created_at

String

完成创建时间。 格式为时间戳，指从格林威治时间1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。

product_id

String

产品标识。

security_group_id

String

安全组ID。

security_group_name

String

租户安全组名称。

subnet_id

String

子网ID。

subnet_name

String

子网名称。

subnet_cidr

String

子网路由。

available_zones

Array of strings

IO未售罄的可用区列表。

user_id

String

用户ID。

user_name

String

用户名。

maintain_begin

String

维护时间窗开始时间，格式为HH:mm:ss。

maintain_end

String

维护时间窗结束时间，格式为HH:mm:ss。

enable_log_collection

Boolean

是否开启消息收集功能。

storage_space

Integer

存储空间，单位：GB。

used_storage_space

Integer

已用消息存储空间，单位：GB。

enable_publicip

Boolean

是否开启公网。

publicip_id

String

实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能（即enable_publicip为true），该字段为必选。

publicip_address

String

公网IP地址。

ssl_enable

Boolean

是否开启SSL。

cross_vpc_info

String

跨VPC访问信息。

storage_resource_id

String

存储资源ID。

storage_spec_code

String

存储规格代码。

service_type

String

服务类型。

storage_type

String

存储类型。

extend_times

Integer

扩展时间。

ipv6_enable

Boolean

是否开启IPv6。

support_features

String

实例支持的特性功能。

disk_encrypted

Boolean

是否开启磁盘加密。

ces_version

String

云监控版本。

node_num

Integer

节点数。

new_spec_billing_enable

Boolean

是否启用新规格计费。

enable_acl

Boolean

是否开启访问控制列表。

broker_num

Integer

节点数。

namesrv_address

String

元数据地址。

broker_address

String

业务数据地址。

public_namesrv_address

String

公网元数据地址。

public_broker_address

String

公网业务数据地址。

tags

Array of TagEntity objects

标签列表。

total_storage_space

Integer

总存储空间。

resource_spec_code

String

资源规格。
表3 TagEntity

参数

参数类型

描述

key

String

键。最大长度36个unicode字符。

key不能为空，不能为空字符串。

不能包含下列字符：非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

String

值。每个值最大长度43个unicode字符。

value不能为空，可以空字符串。

不能包含下列字符：非打印字符ASCII(0-31), “=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

请求示例

查询指定实例。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}

响应示例

状态码： 200

查询实例成功。

{
  "name" : "reliability-test",
  "engine" : "reliability",
  "status" : "RUNNING",
  "description" : "",
  "type" : "cluster",
  "specification" : "c6.4u8g.cluster * 1 broker",
  "engine_version" : "4.8.0",
  "instance_id" : "68fdc9a8-805e-439d-8dd9-25adc1c58bf6",
  "resource_spec_code" : "",
  "charging_mode" : 1,
  "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf",
  "vpc_name" : "vpc-1101840",
  "created_at" : "1636699753874",
  "product_id" : "c6.4u8g.cluster",
  "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c",
  "security_group_name" : "Sys-default",
  "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50",
  "subnet_name" : "subnet-boce",
  "subnet_cidr" : "192.168.1.0/24",
  "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ],
  "user_id" : "0b01fbb53600d4671fa8c00673c71260",
  "user_name" : "",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00",
  "enable_log_collection" : false,
  "storage_space" : 558,
  "total_storage_space" : 600,
  "used_storage_space" : 28,
  "enable_publicip" : true,
  "publicip_id" : "7e6b7beb-ef13-4805-878d-285890b17a12,87827295-84e1-4118-9ab3-a90dd8c9dace,91306a18-5781-4529-b739-5aeec10ec4e6,a68e8f0e-a24f-4521-910e-39696a56fcdf,bb1cd147-a7af-46ca-9548-99fec4034ba2",
  "publicip_address" : "***",
  "ssl_enable" : false,
  "cross_vpc_info" : "{\"192.168.1.21\":{\"advertised_ip\":\"192.168.1.21\",\"broker_port\":\"-\",\"port_id\":\"fa020857-d899-497c-a5f8-8dd90ed67ff7\",\"namesrv_port\":\"8301\"},\"192.168.1.246\":{\"advertised_ip\":\"192.168.1.246\",\"broker_port\":\"10100\",\"port_id\":\"c0f0586f-a4ee-41b5-a7f1-b4e554bbf12d\",\"namesrv_port\":\"-\"},\"192.168.1.77\":{\"advertised_ip\":\"192.168.1.77\",\"broker_port\":\"10101\",\"port_id\":\"8eb1d144-4315-402f-8498-37c9a10b630c\",\"namesrv_port\":\"-\"},\"192.168.1.159\":{\"advertised_ip\":\"192.168.1.159\",\"broker_port\":\"-\",\"port_id\":\"d35b22af-a202-4329-bda4-26e1bdf2aa8e\",\"namesrv_port\":\"8300\"},\"192.168.1.14\":{\"advertised_ip\":\"192.168.1.14\",\"broker_port\":\"10102\",\"port_id\":\"5fcb50fd-3af5-4123-a455-a67f1b926026\",\"namesrv_port\":\"-\"}}",
  "storage_resource_id" : "164bdaef-2e67-4fd5-be8b-a18f91d455a2",
  "storage_spec_code" : "dms.physical.storage.ultra.v2",
  "service_type" : "advanced",
  "storage_type" : "hec",
  "extend_times" : 0,
  "ipv6_enable" : false,
  "support_features" : "kafka.crossvpc.domain.enable,feature.physerver.kafka.topic.accesspolicy,rabbitmq.plugin.management,rocketmq.acl,roma_app_enable,auto_topic_switch,feature.physerver.kafka.user.manager,enable.new.authinfo,route,kafka.config.dynamic.modify.enable,kafka.new.pod.port,feature.physerver.kafka.topic.modify,message_trace_enable,features.pod.token.access,kafka.ssl.cert.modify.enable,roma.user.manage.no.support,feature.physerver.kafka.pulbic.dynamic,features.log.collection,kafka.config.static.modify.enable",
  "disk_encrypted" : false,
  "ces_version" : "linux,v1,v2",
  "node_num" : 5,
  "new_spec_billing_enable" : true,
  "enable_acl" : false,
  "broker_num" : 1,
  "namesrv_address" : "***",
  "broker_address" : "***",
  "public_namesrv_address" : "***",
  "public_broker_address" : "***"
}

状态码

状态码

描述

200

查询实例成功。

错误码

请参见错误码。

父主题： 生命周期管理