5.1 生命周期管理
5.1.2 查询所有实例列表
"key" : "key2", "value" : "value2"
} ] }
响应示例
状态码： 200 创建实例成功。
{ "instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}
状态码
状态码 描述
200 创建实例成功。
错误码
请参见错误码。
5.1.2 查询所有实例列表
功能介绍
查询租户的实例列表，支持按照条件查询。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/{project_id}/instances
表5-5 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
表5-6 Query 参数
参数 是否必选 参数类型 描述
engine 否 String 消息引擎：kafka。
name 否 String 实例名称。
instance_id 否 String 实例ID。
status 否 String 实例状态。
include_failur
e 否 String 是否返回创建失败的实例数。
当参数值为“true”时，返回创 建失败的实例数。参数值为
“false”或者其他值，不返回 创建失败的实例数。
exact_match_
name 否 String 是否按照实例名称进行精确匹配
查询。
默认为“false”，表示模糊匹 配实例名称查询。若参数值为
“true”表示按照实例名称进行 精确匹配查询。
enterprise_pro
ject_id 否 String 企业项目ID。
请求参数
无
响应参数
状态码： 200
表5-7 响应 Body 参数
参数 参数类型 描述
instances Array of
ShowInstanc eResp objects
实例列表
instance_num Integer 实例数量。
表5-8 ShowInstanceResp
参数 参数类型 描述
name String 实例名称。
engine String 引擎。
engine_versio
n String 版本。
specification String 实例规格。
storage_space Integer 消息存储空间，单位：GB。
partition_num String Kafka实例的分区数量。
used_storage_
space Integer 已使用的消息存储空间，单位：GB。
connect_addr
ess 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_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
String Kafka实例的KafkaManager连接地址。
ssl_enable Boolean 是否开启安全认证。
● true：开启
● false：未开启 enterprise_pro
ject_id String 企业项目ID。
is_logical_volu
me Boolean 实例扩容时用于区分老实例与新实例。
● true：新创建的实例，允许磁盘动态扩容不需 要重启。
● false：老实例
extend_times Integer 实例扩容磁盘次数，如果超过20次则无法扩容磁 盘。
enable_auto_t
opic Boolean 是否打开kafka自动创建topic功能。
● true：开启
● false：关闭
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。
public_connec
t_address String 实例公网连接IP地址。当实例开启了公网访问，
实例才包含该参数。
参数 参数类型 描述 storage_resou
rce_id String 存储资源ID。
storage_spec_
code String IO规格。
service_type String 服务类型。
storage_type String 存储类型。
retention_poli
cy String 消息老化策略。
kafka_public_
status String Kafka公网开启状态。
public_bandwi
dth Integer 公网带宽。
kafka_manag
er_user String 登录Kafka Manager的用户名。
enable_log_co
llection Boolean 是否开启消息收集功能。
cross_vpc_info String 跨VPC访问信息。
ipv6_enable Boolean 是否开启ipv6。
ipv6_connect_
addresses Array of
strings IPv6的连接地址。
connector_en
able Boolean 是否开启转储。
connector_id String 转储任务ID。
rest_enable Boolean 是否开启Kafka rest功能。
rest_connect_
address String Kafka rest连接地址。
message_quer
y_inst_enable Boolean 是否开启消息查询功能。
vpc_client_pla
in Boolean 是否开启VPC明文访问。
support_featu
res String Kafka实例支持的特性功能。
trace_enable Boolean 是否开启消息轨迹功能。
pod_connect_
address String 租户侧连接地址。
参数 参数类型 描述
String Kafka实例私有连接地址。
ces_version String 云监控版本。
tags Array of
TagEntity
objects标签列表。
dr_enable Boolean 是否为容灾实例。
表5-9 TagEntity
参数 参数类型 描述
key String 键。最大长度36个unicode字符。
key不能为空，不能为空字符串。
不能包含下列字符：非打印字符ASCII(0-31)，
“=”,“*”,“<”,“>”,“\”,“,”,“|”,
“/”。
value String 值。每个值最大长度43个unicode字符。
value不能为空，可以空字符串。
不能包含下列字符：非打印字符ASCII(0-31),
“=”,“*”,“<”,“>”,“\”,“,”,“|”,
“/”。
请求示例
GET https://{endpoint}/v2/{project_id}/instances
响应示例
状态码： 200
查询所有实例列表成功。
{ "instances" : [ {
"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_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_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,
"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"
} ],
"instance_num" : 1 }
状态码
状态码 描述
200 查询所有实例列表成功。
错误码
请参见错误码。