查询所有实例列表
功能介绍
查询租户的实例列表，支持按照条件查询。
URI
GET /v1.0/{project_id}/instances?engine={engine}&name={name}&status={status}&id={id}&includeFailure={includeFailure}&exactMatchName={exactMatchName}&enterprise_project_id={enterprise_project_id}
参数说明见表1。
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。 |
|
engine |
String |
否 |
消息引擎：kafka。 |
|
name |
String |
否 |
实例名称。 |
|
id |
String |
否 |
实例ID。 |
|
status |
String |
否 |
实例状态。详细状态说明见实例状态说明。 |
|
includeFailure |
String |
否 |
是否返回创建失败的实例数。 当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。 |
|
exactMatchName |
String |
否 |
是否按照实例名称进行精确匹配查询。 默认为“false”，表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。 |
|
enterprise_project_id |
String |
否 |
企业项目ID。 |
请求消息
请求参数
无。
请求示例
GET https://{dms_endpoint}/v1.0/{project_id}/instances?start=1&limit=10&name=&status=&id=&includeFailure=true&exactMatchName=false
响应消息
响应参数
参数说明见表2。
|
参数 |
类型 |
说明 |
|---|---|---|
|
name |
String |
实例名称。 |
|
engine |
String |
引擎。 |
|
engine_version |
String |
版本。 |
|
specification |
String |
实例规格。 |
|
storage_space |
Integer |
消息存储空间，单位：GB。 |
|
partition_num |
String |
Kafka实例的最大topic数。 |
|
used_storage_space |
Integer |
已使用的消息存储空间，单位：GB。 |
|
connect_address |
String |
实例连接IP地址。 |
|
port |
Integer |
实例连接端口。 |
|
status |
String |
实例的状态。详细状态说明见实例状态说明。 |
|
instance_id |
String |
实例ID。 |
|
resource_spec_code |
String |
资源规格标识。
|
|
charging_mode |
Integer |
计费模式。 |
|
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 |
用户名。 |
|
access_user |
String |
实例的用户名。 |
|
maintain_begin |
String |
维护时间窗开始时间，格式为HH:mm:ss。 |
|
maintain_end |
String |
维护时间窗结束时间，格式为HH:mm:ss。 |
|
management_connect_address |
String |
Kafka实例的Kafka Manager连接地址。 |
|
ssl_enable |
Boolean |
是否开启安全认证。
|
|
enterprise_project_id |
String |
企业项目ID。 |
|
is_logical_volume |
Boolean |
实例扩容时用于区分老实例与新实例。
|
|
extend_times |
Integer |
实例扩容磁盘次数，如果超过20次则无法扩容磁盘。 |
|
enable_auto_topic |
Boolean |
是否打开kafka自动创建topic功能。
|
|
type |
String |
实例类型：集群，cluster。 |
|
product_id |
String |
产品标识。 |
|
security_group_id |
String |
安全组ID。 |
|
security_group_name |
String |
租户安全组名称。 |
|
subnet_id |
String |
子网ID。 |
|
available_zones |
Array |
实例节点所在的可用区，返回“可用区ID”。 |
|
total_storage_space |
Integer |
总共消息存储空间，单位：GB。 |
|
storage_resource_id |
String |
存储资源ID。 |
|
storage_spec_code |
String |
IO规格。 |
|
service_type |
String |
服务类型。 |
|
storage_type |
String |
存储类型。 |
|
retention_policy |
String |
消息老化策略。 |
|
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的连接地址。 |
|
rest_enable |
Boolean |
是否开启Kafka rest功能。 |
|
rest_connect_address |
String |
Kafka rest地址。 |
|
message_query_inst_enable |
Boolean |
是否开启消息查询功能。 |
|
vpc_client_plain |
Boolean |
是否开启VPC明文访问。 |
|
support_features |
String |
Kafka实例支持的特性功能。 |
|
trace_enable |
Boolean |
是否开启消息轨迹功能。 |
|
pod_connect_address |
String |
租户侧连接地址。 |
|
disk_encrypted |
Boolean |
是否开启磁盘加密。 |
|
kafka_private_connect_address |
String |
Kafka实例私有连接地址。 |
|
ces_version |
String |
云监控版本。 |
|
tags |
Array<Object> |
标签列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
标签的键。 |
|
value |
String |
标签的值。 |
响应示例
