查询所有实例列表

project_id

是

String

项目ID，获取方式请参见获取项目ID。

engine

否

String

消息引擎：kafka。

缺省值：kafka

name

否

String

实例名称。

instance_id

否

String

实例ID。

status

否

String

实例状态。 详细状态说明请参考实例状态说明。

include_failure

否

String

是否返回创建失败的实例数。

当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。

exact_match_name

否

String

是否按照实例名称进行精确匹配查询。

默认为“false”，表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。

enterprise_project_id

否

String

企业项目ID。

offset

否

String

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

String

当次查询返回的最大实例个数，默认值为10，取值范围为1~50。

instances

Array of ShowInstanceResp objects

实例列表

instance_num

Integer

实例数量。

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

是否为容灾实例。

key

String

键。

key不能为空，长度1~128个字符（中文也可以输入128个字符）。

可用UTF-8格式表示的字母、数字和空格，以及以下字符： _ . : = + - @

key两头不能有空格字符。

value

String

值。

长度0~255个字符（中文也可以输入255个字符）。

可用UTF-8格式表示的字母、数字和空格，以及以下字符： _ . : / = + - @。

value可以为空字符串。

200

响应示例如下：