本文导读

展开导读

文档首页/ 分布式消息服务Kafka版/ API参考/ 历史API/ API V1/ 实例管理类接口/ 查询指定实例

查询指定实例

更新时间：2025-05-06 GMT+08:00

查看PDF

说明：

当前页面API为历史版本API，未来可能停止维护。请使用查询指定实例。

功能介绍

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

URI

GET /v1.0/{project_id}/instances/{instance_id}

参数说明见表1。

表1 参数说明
参数	类型	必选	说明
project_id	String	是	项目ID。
instance_id	String	是	实例ID。

请求消息

请求参数

无。

请求示例

GET https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}

响应消息

响应参数

参数说明见表2。

表2 参数说明
参数	类型	说明
name	String	实例名称。
engine	String	消息引擎。
engine_version	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/秒。
type	String	实例类型：集群，cluster
charging_mode	Integer	付费模式，1表示按需计费，0表示包年/包月计费。
vpc_id	String	VPC ID。
vpc_name	String	VPC的名称。
created_at	String	完成创建时间。格式为时间戳，指从格林威治时间 1970年01月01日00时00分00秒起至指定时间的偏差总毫秒数。
product_id	String	产品标识。
security_group_id	String	安全组ID。
security_group_name	String	租户安全组名称。
subnet_id	String	子网ID。
subnet_name	String	子网名称。
subnet_cidr	String	子网网段。
available_zones	Array	实例节点所在的可用区，返回“可用区ID”。
user_id	String	用户id。
user_name	String	用户名。
access_user	String	实例的用户名。
order_id	String	订单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：未开启
enterprise_project_id	String	企业项目ID。
is_logical_volume	Boolean	实例扩容时用于区分老实例与新实例。 true：新创建的实例，允许磁盘动态扩容不需要重启。 false：老实例。
extend_times	Integer	实例扩容磁盘次数，如果超过20次则无法扩容磁盘。
enable_auto_topic	Boolean	是否打开Kafka自动创建Topic功能。 true：开启 false：关闭
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_public_status	String	Kafka公网开启状态。
public_bandwidth	Integer	公网带宽。
public_connect_address	String	实例公网连接IP地址。当实例开启了公网访问，实例才包含该参数。
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>	标签列表。

表3 tags
参数	参数类型	描述
key	String	标签的键。
value	String	标签的值。

响应示例

{
    "name": "kafka-l00230526",
    "engine": "kafka",
    "port": 9092,
    "status": "RUNNING",
    "type": "cluster",
    "specification": "100MB",
    "engine_version": "XXX",
    "connect_address": "192.168.1.116,192.168.1.152,192.168.1.78",
    "connect_dn": "",
    "instance_id": "ef84dd5f-3ece-4336-8c99-987defd62e3a",
    "resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
    "charging_mode": 1,
    "vpc_id": "2477879f-aebf-496f-a08a-67812885ce9b",
    "vpc_name": "vpc-y00502467",
    "created_at": "1568797295209",
    "product_id": "00300-30308-0--0",
    "security_group_id": "008a08e2-10cc-4d9b-90ab-3f3b8f6c3333",
    "security_group_name": "z00417080-cce-node-na7j",
    "subnet_id": "5ca08fb7-7522-4d95-9fa5-ff6b3592a29d",
    "subnet_name": "subnet-cyd-6102",
    "subnet_cidr": "192.168.1.0/24",
    "available_zones": [
        "ae04cf9d61544df3806a3feeb401b204"
    ],
    "user_id": "2b4af4428ec840dfa1f0f1a32e965567",
    "user_name": "laiyh",
    "kafka_manager_user": "root",
    "maintain_begin": "22:00:00",
    "maintain_end": "02:00:00",
    "storage_space": 492,
    "total_storage_space": 600,
    "used_storage_space": 25,
    "partition_num": "300",
    "ssl_enable": false,
    "management_connect_address": "https://192.168.1.116:9999",
    "storage_resource_id": "81982562-ce8b-490a-95fa-2b225c292271",
    "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": "",
    "message_query_inst_enable": true,
    "vpc_client_plain": false,
    "support_features": "feature.physerver.kafka.topic.accesspolicy,message_trace_enable,features.pod.token.access,feature.physerver.kafka.pulbic.dynamic,feature.physerver.kafka.user.manager",
    "trace_enable": false,
    "agent_enable": false,
    "pod_connect_address": "100.113.16.105:9100,100.113.5.197:9100,100.113.15.231:9100",
    "disk_encrypted": false,
    "enable_auto_topic": true
}

状态码

操作成功的状态码如表4所示，其他响应见状态码。

表4 状态码
状态码	描述
200	查询指定实例成功。

父主题：实例管理类接口

上一篇：创建Kafka实例

下一篇：修改实例信息

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消