5.1 生命周期管理
5.1.3 查询指定实例
功能介绍
查询指定实例的详细信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/instances/{instance_id}
表5-10 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
instance_id 是 String 实例ID。
请求参数
无
响应参数
状态码： 200
表5-11 响应 Body 参数
参数 参数类型 描述
name String 实例名称。
engine String 消息引擎。
engine_versio
n String 消息引擎版本。
specification String 实例规格。
● RabbitMQ实例单机返回vm规格。
● RabbitMQ实例集群返回vm规格和节点数。
storage_space Integer 消息存储空间，单位：GB。
used_storage_
space Integer 已使用的消息存储空间，单位：GB。
connect_addr
ess String 实例连接IP地址。
参数 参数类型 描述
port Integer 实例连接端口。
status String 实例的状态。
description String 实例描述。
instance_id String 实例ID。
resource_spec
_code String 资源规格标识。
● dms.instance.rabbitmq.single.c3.2u4g：
RabbitMQ单机，vm规格2u4g
● dms.instance.rabbitmq.single.c3.4u8g：
RabbitMQ单机，vm规格4u8g
● dms.instance.rabbitmq.single.c3.8u16g：
RabbitMQ单机，vm规格8u16g
● dms.instance.rabbitmq.single.c3.16u32g：
RabbitMQ单机，vm规格16u32g
● dms.instance.rabbitmq.cluster.c3.4u8g.3：
RabbitMQ集群，vm规格4u8g，3个节点
● dms.instance.rabbitmq.cluster.c3.4u8g.5：
RabbitMQ集群，vm规格4u8g，5个节点
● dms.instance.rabbitmq.cluster.c3.4u8g.7：
RabbitMQ集群，vm规格4u8g，7个节点
● dms.instance.rabbitmq.cluster.c3.8u16g.3：
RabbitMQ集群，vm规格8u16g，3个节点
● dms.instance.rabbitmq.cluster.c3.8u16g.5：
RabbitMQ集群，vm规格8u16g，5个节点
● dms.instance.rabbitmq.cluster.c3.8u16g.7：
RabbitMQ集群，vm规格8u16g，7个节点
● dms.instance.rabbitmq.cluster.c3.16u32g.3：
RabbitMQ集群，vm规格16u32g，3个节点
● dms.instance.rabbitmq.cluster.c3.16u32g.5：
RabbitMQ集群，vm规格16u32g，5个节点
● dms.instance.rabbitmq.cluster.c3.16u32g.7：
RabbitMQ集群，vm规格16u32g，7个节点 charging_mod
e Integer 付费模式，1表示按需计费，0表示包年/包月计
费。
vpc_id String VPC ID。
vpc_name String VPC的名称。
created_at String 完成创建时间。格式为时间戳，指从格林威治时 间 1970年01月01日00时00分00秒起至指定时间 的偏差总毫秒数。
user_id String 用户ID。
参数 参数类型 描述 user_name String 用户名。
order_id String 订单ID，只有在包周期计费时才会有order_id 值，其他计费方式order_id值为空。
maintain_begi
n String 维护时间窗开始时间，格式为HH:mm:ss。
maintain_end String 维护时间窗结束时间，格式为HH:mm:ss。
enable_publici
p Boolean RabbitMQ实例是否开启公网访问功能。
● true：开启
● false：未开启 publicip_addr
ess String RabbitMQ实例绑定的弹性IP地址。
如果未开启公网访问功能，该字段值为null。
publicip_id String RabbitMQ实例绑定的弹性IP地址的ID。
如果未开启公网访问功能，该字段值为null。
management _connect_add ress
String RabbitMQ实例的管理地址。
ssl_enable Boolean 是否开启安全认证。
● true：开启
● false：未开启 enterprise_pro
ject_id String 企业项目ID。
is_logical_volu
me Boolean 实例扩容时用于区分老实例与新实例。
● true：新创建的实例，允许磁盘动态扩容不需 要重启。
● false：老实例
extend_times Integer 实例扩容磁盘次数，如果超过20次则无法扩容磁 盘。
type String 实例类型：集群，cluster。
product_id String 产品标识。
security_grou
p_id String 安全组ID。
security_grou
p_name String 租户安全组名称。
subnet_id String 子网ID。
available_zon
es Array of
strings 实例节点所在的可用区，返回“可用区ID”。
参数 参数类型 描述 total_storage_
space Integer 总共消息存储空间，单位：GB。
storage_resou
rce_id String 存储资源ID。
storage_spec_
code String IO规格。
ipv6_enable Boolean 是否开启ipv6。
ipv6_connect_
addresses Array of
strings IPv6的连接地址。
tags Array of
TagEntity
objects标签列表。
表5-12 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" : "api-explorer", "engine" : "rabbitmq", "port" : 5672, "status" : "RUNNING", "type" : "single",
"specification" : "2vCPUs 4GB",
"engine_version" : "3.7.17", "connect_address" : "192.168.0.74", "connect_dn" : "",
"instance_id" : "de873040-d661-4770-aa96-9329c71d7c8a", "resource_spec_code" : "dms.instance.rabbitmq.single.c3.2u4g", "charging_mode" : 1,
"vpc_id" : "40a6501e-85ca-4449-a0db-b8bc7f0cec28", "vpc_name" : "vpc-a400",
"created_at" : "1590047080687", "product_id" : "00300-30109-0--0",
"security_group_id" : "bfd68e26-f8ef-4a91-a373-0a8f5c198601", "security_group_name" : "Sys-default",
"subnet_id" : "a7f9a564-30dd-4059-8124-364ca6554578", "subnet_name" : "subnet-a429",
"subnet_cidr" : "192.168.0.0/24",
"available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "user_id" : "3df5acbc24a54fadb62a043c9000a307",
"user_name" : "paas_dms_pwx483199_01", "access_user" : "root",
"maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "enable_log_collection" : false, "storage_space" : 88,
"total_storage_space" : 100, "used_storage_space" : 4, "enable_publicip" : false, "ssl_enable" : false,
"management_connect_address" : "http://192.168.0.74:15672", "storage_resource_id" : "52be287d-1d6a-4d30-937e-185b3f176fc4", "storage_spec_code" : "dms.physical.storage.normal",
"service_type" : "advanced", "storage_type" : "hec", "enterprise_project_id" : "0", "tags" : [ {
"is_logical_volume" : true, "extend_times" : 0, "ipv6_enable" : false,
"ipv6_connect_addresses" : [ ], "connector_enable" : false, "connector_id" : "", "rest_enable" : false, "rest_connect_address" : "", "public_boundwidth" : 0,
"message_query_inst_enable" : true, "vpc_client_plain" : false,
"support_features" :
"kafka.new.pod.port,feature.physerver.kafka.topic.modify,feature.physerver.kafka.topic.accesspolicy,message_t race_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,roma_app_enable,features.log.c ollection,auto_topic_switch,feature.physerver.kafka.user.manager",
"trace_enable" : false, "agent_enable" : false, "disk_encrypted" : false, "enable_auto_topic" : false, "ces_version" : "linux,v1"
}
状态码
状态码 描述
200 查询指定实例成功。
错误码
请参见错误码。