查询指定实例

功能介绍

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见获取项目ID。
instance_id	是	String	实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数
参数	参数类型	描述
name	String	实例名称。
engine	String	引擎。
engine_version	String	版本。
description	String	实例描述。
specification	String	实例规格。
storage_space	Integer	消息存储空间，单位：GB。
partition_num	String	Kafka实例的分区数量。
used_storage_space	Integer	已使用的消息存储空间，单位：GB。
connect_address	String	实例连接IP地址。
port	Integer	实例连接端口。
status	String	实例的状态。详细状态说明请参考实例状态说明。
instance_id	String	实例ID。
resource_spec_code	String	资源规格标识。 dms.instance.kafka.cluster.c3.mini：Kafka实例的基准带宽为100MByte/秒。 dms.instance.kafka.cluster.c3.small.2：Kafka实例的基准带宽为300MByte/秒。 dms.instance.kafka.cluster.c3.middle.2：Kafka实例的基准带宽为600MByte/秒。 dms.instance.kafka.cluster.c3.high.2：Kafka实例的基准带宽为1200MByte/秒。
charging_mode	Integer	付费模式，暂未使用。
vpc_id	String	VPC ID。
vpc_name	String	VPC的名称。
created_at	String	完成创建时间。格式为时间戳，指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。
subnet_name	String	子网名称。
subnet_cidr	String	子网网段。
user_id	String	用户ID。
user_name	String	用户名。
access_user	String	实例访问用户名。
order_id	String	订单ID，只有在包周期计费时才会有order_id值，其他计费方式order_id值为空。
maintain_begin	String	维护时间窗开始时间，格式为HH:mm:ss。
maintain_end	String	维护时间窗结束时间，格式为HH:mm:ss。
enable_publicip	Boolean	实例是否开启公网访问功能。 true：开启 false：未开启
management_connect_address	String	Kafka实例的Kafka Manager连接地址。
ssl_enable	Boolean	是否开启安全认证。 true：开启 false：未开启
kafka_security_protocol	String	开启SASL后使用的安全协议。 SASL_SSL: 采用SSL证书进行加密传输，支持账号密码认证，安全性更高。 SASL_PLAINTEXT: 明文传输，支持账号密码认证，性能更好，建议使用SCRAM-SHA-512机制。
sasl_enabled_mechanisms	Array of Strings	开启SASL后使用的认证机制。 PLAIN: 简单的用户名密码校验。 SCRAM-SHA-512: 用户凭证校验，安全性比PLAIN机制更高。
ssl_two_way_enable	Boolean	是否开启双向认证。
cert_replaced	Boolean	是否能够证书替换。
public_management_connect_address	String	公网访问Kafka Manager连接地址。
enterprise_project_id	String	企业项目ID。
is_logical_volume	Boolean	实例扩容时用于区分老实例与新实例。 true：新创建的实例，允许磁盘动态扩容不需要重启。 false：老实例
extend_times	Integer	实例扩容磁盘次数，如果超过20次则无法扩容磁盘。
enable_auto_topic	Boolean	是否打开kafka自动创建topic功能。 true：开启 false：关闭
type	String	实例类型：集群，cluster。
product_id	String	产品标识。
security_group_id	String	安全组ID。
security_group_name	String	租户安全组名称。
subnet_id	String	子网ID。
available_zones	Array of Strings	实例节点所在的可用区，返回“可用区ID”。
total_storage_space	Integer	总共消息存储空间，单位：GB。
public_connect_address	String	实例公网连接IP地址。当实例开启了公网访问，实例才包含该参数。
storage_resource_id	String	存储资源ID。
storage_spec_code	String	IO规格。
service_type	String	服务类型。
storage_type	String	存储类型。
retention_policy	String	消息老化策略。
kafka_public_status	String	Kafka公网开启状态。
public_bandwidth	Integer	kafka公网访问带宽。
kafka_manager_enable	Boolean	是否已开启kafka manager
kafka_manager_user	String	登录Kafka Manager的用户名。
enable_log_collection	Boolean	是否开启消息收集功能。
cross_vpc_info	String	跨VPC访问信息。
ipv6_enable	Boolean	是否开启ipv6。
ipv6_connect_addresses	Array of Strings	IPv6的连接地址。
connector_enable	Boolean	是否开启转储。新规格产品暂不支持开启转储。
connector_id	String	转储任务ID。
rest_enable	Boolean	是否开启Kafka rest功能。
rest_connect_address	String	Kafka rest连接地址。
public_boundwidth	Integer	kafka公网访问带宽。待删除版本。
message_query_inst_enable	Boolean	是否开启消息查询功能。
vpc_client_plain	Boolean	是否开启VPC明文访问。
support_features	String	Kafka实例支持的特性功能。
trace_enable	Boolean	是否开启消息轨迹功能。
agent_enable	Boolean	是否开启代理。
pod_connect_address	String	租户侧连接地址。
disk_encrypted	Boolean	是否开启磁盘加密。
disk_encrypted_key	String	磁盘加密key，未开启磁盘加密时为空。
kafka_private_connect_address	String	Kafka实例私有连接地址。
ces_version	String	云监控版本。
public_access_enabled	String	区分实例什么时候开启的公网访问：true,actived,closed,false。
node_num	Integer	节点数。
enable_acl	Boolean	是否开启访问控制。
new_spec_billing_enable	Boolean	是否启用新规格计费。
broker_num	Integer	节点数量。
tags	Array of TagEntity objects	标签列表。
dr_enable	Boolean	是否为容灾实例。

表3 TagEntity
参数	参数类型	描述
key	String	标签键。不能为空。对于同一个实例，Key值唯一。长度不超过36个字符。不能包含“=”，“*”，“<”，“>”，“\”，“,”，“\|”，“/” 首尾字符不能为空格。
value	String	标签值。不能为空。长度不超过43个字符。不能包含“=”，“*”，“<”，“>”，“\”，“,”，“\|”，“/” 首尾字符不能为空格。

请求示例

查询指定实例

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

响应示例

状态码： 200

响应示例如下：

查询实例成功。

{
  "name" : "kafka-2085975099",
  "engine" : "kafka",
  "port" : 9092,
  "status" : "RUNNING",
  "type" : "cluster",
  "specification" : "100MB",
  "engine_version" : "1.1.0",
  "connect_address" : "192.168.0.100,192.168.0.61,192.168.0.72",
  "instance_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "resource_spec_code" : "dms.instance.kafka.cluster.c3.mini",
  "charging_mode" : 1,
  "vpc_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "vpc_name" : "dms-test",
  "created_at" : "1585618587087",
  "product_id" : "00300-30308-0--0",
  "security_group_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "security_group_name" : "Sys-default",
  "subnet_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "available_zones" : [ "38b0f7a602344246bcb0da47b5d548e7" ],
  "user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "user_name" : "paas_dms",
  "kafka_manager_enable" : false,
  "kafka_manager_user" : "root",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00",
  "enable_log_collection" : false,
  "storage_space" : 492,
  "total_storage_space" : 600,
  "used_storage_space" : 25,
  "partition_num" : "300",
  "enable_publicip" : false,
  "ssl_enable" : false,
  "management_connect_address" : "https://192.168.0.100:9999",
  "cross_vpc_info" : "{\"192.168.0.61\":{\"advertised_ip\":\"192.168.0.61\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.72\":{\"advertised_ip\":\"192.168.0.72\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"},\"192.168.0.100\":{\"advertised_ip\":\"192.168.0.100\",\"port\":9011,\"port_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}",
  "storage_resource_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "storage_spec_code" : "dms.physical.storage.ultra",
  "service_type" : "advanced",
  "storage_type" : "hec",
  "enterprise_project_id" : "0",
  "is_logical_volume" : true,
  "extend_times" : 0,
  "retention_policy" : "produce_reject",
  "ipv6_enable" : false,
  "ipv6_connect_addresses" : [ ],
  "connector_enable" : false,
  "connector_id" : "",
  "rest_enable" : false,
  "rest_connect_address" : "",
  "kafka_public_status" : "closed",
  "public_bandwidth" : 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_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,roma_app_enable,features.log.collection,auto_topic_switch,feature.physerver.kafka.user.manager",
  "trace_enable" : false,
  "agent_enable" : false,
  "pod_connect_address" : "100.86.75.15:9080,100.86.142.77:9080,100.86.250.167:9080",
  "disk_encrypted" : false,
  "kafka_private_connect_address" : "192.168.0.61:9092,192.168.0.100:9092,192.168.0.72:9092",
  "enable_auto_topic" : false,
  "ces_version" : "linux"
}

状态码

状态码	描述
200	响应示例如下：

错误码

请参见错误码。

父主题： 生命周期管理

上一篇：查询所有实例列表

下一篇：删除指定的实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试