查询所有实例列表

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

engine

是

String

参数解释：

消息引擎。

约束限制：

不涉及。

取值范围：

kafka。

默认取值：

不涉及。

name

否

String

参数解释：

实例名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

否

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

status

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

include_failure

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

• 'true'：返回创建失败的实例数。

• 'false'：不返回创建失败的实例数。

默认取值：

不涉及。

exact_match_name

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

• 'true'：表示按照实例名称进行精确匹配查询。

• 'false'：表示模糊匹配实例名称查询。

默认取值：

'false'。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

String

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

不涉及。

limit

否

String

参数解释：

当次查询返回的实例最大个数。

约束限制：

不涉及。

取值范围：

1~50。

默认取值：

10。

instances

Array of ShowInstanceResp objects

参数解释：

实例列表。

instance_num

Integer

参数解释：

实例数量。

取值范围：

不涉及。

name

String

参数解释：

实例名称。

取值范围：

不涉及。

engine

String

参数解释：

引擎。

取值范围：

kafka

engine_version

String

参数解释：

Kafka的版本。

取值范围：

• 1.1.0

• 2.3.0

• 2.7

• 3.x

description

String

参数解释：

实例描述。

取值范围：

不涉及。

specification

String

参数解释：

实例规格。

取值范围：

不涉及。

storage_space

Integer

参数解释：

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

取值范围：

• Kafka实例规格为c6.2u4g.cluster时，存储空间取值范围300GB ~ 300000GB。

• Kafka实例规格为c6.4u8g.cluster时，存储空间取值范围300GB ~ 600000GB。

• Kafka实例规格为c6.8u16g.cluster时，存储空间取值范围300GB ~ 1500000GB。

• Kafka实例规格为c6.12u24g.cluster时，存储空间取值范围300GB ~ 1500000GB。

• Kafka实例规格为c6.16u32g.cluster时，存储空间取值范围300GB ~ 1500000GB。

partition_num

String

参数解释：

Kafka实例的分区数量。

取值范围：

不涉及。

used_storage_space

Integer

参数解释：

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

取值范围：

不涉及。

dns_enable

Boolean

参数解释：

实例是否开启域名访问功能。

取值范围：

• true：开启

• false：未开启

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

参数解释：

付费模式。

取值范围：

• 1表示按需计费。

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：未开启

broker_ssl_enable

Boolean

参数解释：

是否开启broker间副本加密传输。

取值范围：

• true：开启

• false：未开启

kafka_security_protocol

String

参数解释：

Kafka使用的安全协议。

若实例详情中不存在port_protocols返回参数，则kafka_security_protocol同时代表内网访问、公网访问以及跨VPC访问的安全协议。

若实例详情中存在port_protocols返回参数，则kafka_security_protocol仅代表跨VPC访问的安全协议。内网访问公网访问的安全协议请参考port_protocols参数。

取值范围：

• PLAINTEXT：既未采用SSL证书进行加密传输，也不支持账号密码认证。性能更好，安全性较低，建议在生产环境下公网访问不使用此方式。

• SASL_SSL：采用SSL证书进行加密传输，支持账号密码认证，安全性更高。

• SASL_PLAINTEXT：明文传输，支持账号密码认证，性能更好，建议使用SCRAM-SHA-512机制。

sasl_enabled_mechanisms

Array of strings

参数解释：

开启SASL后使用的认证机制。

ssl_two_way_enable

Boolean

参数解释：

是否开启双向认证。

取值范围：

• true：开启

• false：未开启

cert_replaced

Boolean

参数解释：

是否开启证书替换。

取值范围：

• true：开启

• false：未开启

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

参数解释：

是否开启自动创建Topic。

取值范围：

• true：开启

• false：关闭

type

String

参数解释：

实例类型。

取值范围：

• single：单机。

• cluster：集群。

product_id

String

参数解释：

产品标识。

取值范围：

不涉及。

security_group_id

String

参数解释：

安全组ID。

取值范围：

不涉及。

security_group_name

String

参数解释：

安全组名称。

取值范围：

不涉及。

subnet_id

String

参数解释：

子网ID。

取值范围：

不涉及。

available_zones

Array of strings

参数解释：

实例节点所在的可用区，返回“可用区ID”。

available_zone_names

Array of strings

参数解释：

实例节点所在的可用区名称，返回“可用区名称”。

total_storage_space

Integer

参数解释：

总共消息存储空间，单位：GB。

取值范围：

不涉及。

public_connect_address

String

参数解释：

实例公网连接IP地址。当实例开启了公网访问，实例才包含该参数。

取值范围：

不涉及。

public_connect_domain_name

String

参数解释：

实例公网连接域名。当实例开启了公网访问，实例才包含该参数。

取值范围：

不涉及。

storage_resource_id

String

参数解释：

存储资源ID。

取值范围：

不涉及。

storage_spec_code

String

参数解释：

IO规格。

取值范围：

不涉及。

service_type

String

参数解释：

服务类型。

取值范围：

advanced

storage_type

String

参数解释：

存储类型。

取值范围：

不涉及。

retention_policy

String

参数解释：

消息老化策略。

取值范围：

• time_base：表示自动删除最老消息。

• produce_reject：表示拒绝消息写入。

kafka_public_status

String

参数解释：

Kafka公网开启状态。

取值范围：

• true：开启公网。

• closed：关闭公网。

• false：未使用公网。

• freezed：公网冻结。

• actived：公网解冻。

public_bandwidth

Integer

参数解释：

kafka公网访问带宽。

取值范围：

不涉及。

enable_log_collection

Boolean

参数解释：

是否开启消息收集功能。

取值范围：

• true：开启

• false：不开启

new_auth_cert

Boolean

参数解释：

是否开启新证书。

取值范围：

• true：开启

• false：不开启

cross_vpc_info

String

参数解释：

跨VPC访问信息。

取值范围：

不涉及。

ipv6_enable

Boolean

参数解释：

是否开启IPv6。

取值范围：

• true：开启

• false：不开启

ipv6_connect_addresses

Array of strings

参数解释：

IPv6的连接地址。

connector_enable

Boolean

参数解释：

是否开启转储。

取值范围：

• true：开启

• false：不开启

connector_node_num

Integer

参数解释：

connector节点数量。

取值范围：

2-16。

connector_id

String

参数解释：

转储任务ID。

取值范围：

不涉及。

rest_enable

Boolean

参数解释：

是否开启Kafka rest功能。

取值范围：

• true：开启

• false：不开启

rest_connect_address

String

参数解释：

Kafka rest连接地址。

取值范围：

不涉及。

public_boundwidth

Integer

参数解释：

Kafka公网访问带宽。待删除版本。

取值范围：

不涉及。

message_query_inst_enable

Boolean

参数解释：

是否开启消息查询功能。

取值范围：

• true：开启

• false：不开启

vpc_client_plain

Boolean

参数解释：

是否开启VPC明文访问。

取值范围：

• true：开启

• false：不开启

support_features

String

参数解释：

Kafka实例支持的特性功能。

取值范围：

不涉及。

trace_enable

Boolean

参数解释：

是否开启消息轨迹功能。

取值范围：

• true：开启

• false：不开启

agent_enable

Boolean

参数解释：

是否开启代理。

取值范围：

• true：开启

• false：不开启

pod_connect_address

String

参数解释：

租户侧连接地址。

取值范围：

不涉及。

disk_encrypted

Boolean

参数解释：

是否开启磁盘加密。

取值范围：

• true：开启

• false：不开启

disk_encrypted_key

String

参数解释：

磁盘加密key，未开启磁盘加密时为空。

取值范围：

不涉及。

kafka_private_connect_address

String

参数解释：

Kafka实例内网连接地址。

取值范围：

不涉及。

kafka_private_connect_domain_name

String

参数解释：

Kafka实例内网连接域名。

取值范围：

不涉及。

ces_version

String

参数解释：

云监控版本。

取值范围：

不涉及。

public_access_enabled

String

参数解释：

区分实例什么时候开启的公网访问

取值范围：

• true：已开启公网访问

• actived：已开启公网访问

• closed：已关闭公网访问

• false：已关闭公网访问

node_num

Integer

参数解释： 节点数。 取值范围：

• 3~50：Kafka集群实例的节点数。

port_protocols

PortProtocolsEntity object

参数解释：

实例支持的连接方式及其连接地址。

enable_acl

Boolean

参数解释：

是否开启访问控制。

取值范围：

• true：开启

• false：不开启

new_spec_billing_enable

Boolean

参数解释：

是否启用新规格计费。

取值范围：

• true：开启

• false：不开启

broker_num

Integer

参数解释：

节点数量。

取值范围：

不涉及。

tags

Array of TagEntity objects

参数解释：

标签列表。

dr_enable

Boolean

参数解释：

是否为容灾实例。

取值范围：

• true：是容灾实例。

• false：不是容灾实例。

private_plain_enable

Boolean

参数解释：

实例是否支持内网PLAINTEXT访问接入方式。

取值范围：

• true：实例支持内网PLAINTEXT访问方式接入方式。

• false：实例不支持内网PLAINTEXT访问接入方式。

private_plain_address

String

参数解释：

Kafka内网PLAINTEXT接入方式连接地址。

取值范围：

不涉及

private_plain_domain_name

String

参数解释：

内网明文连接域名。

取值范围：

不涉及

private_sasl_ssl_enable

Boolean

参数解释：

实例是否支持内网SASL_SSL访问接入方式。

取值范围：

• true：实例支持内网SASL_SSL访问方式接入方式。

• false：实例不支持内网SASL_SSL访问接入方式。

private_sasl_ssl_address

String

参数解释：

Kafka内网SASL_SSL接入方式连接地址。

取值范围：

不涉及

private_sasl_ssl_domain_name

String

参数解释：

内网SASL_SSL连接域名。

取值范围：

不涉及

private_sasl_plaintext_enable

Boolean

参数解释：

实例是否支持内网SASL_PLAINTEXT访问接入方式。

取值范围：

• true：实例支持内网SASL_PLAINTEXT访问方式接入方式。

• false：实例不支持内网SASL_PLAINTEXT访问接入方式。

private_sasl_plaintext_address

String

参数解释：

Kafka内网SASL_PLAINTEXT接入方式连接地址。

取值范围：

不涉及

private_sasl_plaintext_domain_name

String

参数解释：

内网SASL_PLAINTEXT连接域名。

取值范围：

不涉及

public_plain_enable

Boolean

参数解释：

实例是否支持公网PLAINTEXT访问接入方式。

取值范围：

• true：实例支持公网PLAINTEXT访问方式接入方式。

• false：实例不支持公网PLAINTEXT访问接入方式。

public_plain_address

String

参数解释：

Kafka公网PLAINTEXT接入方式连接地址。

取值范围：

不涉及

public_plain_domain_name

String

参数解释：

公网明文连接域名。

取值范围：

不涉及

public_sasl_ssl_enable

Boolean

参数解释：

实例是否支持公网SASL_SSL访问接入方式。

取值范围：

• true：实例支持内网SASL_SSL访问方式接入方式。

• false：实例不支持公网SASL_SSL访问接入方式。

public_sasl_ssl_address

String

参数解释：

Kafka公网SASL_SSL接入方式连接地址。

取值范围：

不涉及

public_sasl_ssl_domain_name

String

参数解释：

公网SASL_SSL连接域名。

取值范围：

不涉及

public_sasl_plaintext_enable

Boolean

参数解释：

实例是否支持公网SASL_PLAINTEXT访问接入方式。

取值范围：

• true：实例支持公网SASL_PLAINTEXT访问方式接入方式。

• false：实例不支持公网SASL_PLAINTEXT访问接入方式。

public_sasl_plaintext_address

String

参数解释：

Kafka公网SASL_PLAINTEXT接入方式连接地址。

取值范围：

不涉及

public_sasl_plaintext_domain_name

String

参数解释：

公网SASL_PLAINTEXT连接域名。

取值范围：

不涉及

key

String

参数解释：

标签键。

约束限制：

• 不能为空。

• 对于同一个实例，Key值唯一。

• 长度为1~128个字符（中文也可以输入128个字符）。

• 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @

• 不能以_sys_开头。

• 首尾字符不能为空格。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束限制：

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

• 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @

取值范围：

不涉及。

默认取值：

不涉及。

200

查询所有实例列表成功。