更新时间:2023-08-16 GMT+08:00

查询指定实例

当前页面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

计费模式。

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

实例的用户名。

maintain_begin

String

维护时间窗开始时间,格式为HH:mm:ss。

maintain_end

String

维护时间窗结束时间,格式为HH:mm:ss。

enable_publicip

Boolean

实例是否开启公网访问功能。

  • true:开启
  • false:未开启

ssl_enable

Boolean

是否开启安全认证。

  • true:开启
  • false:未开启

enterprise_project_id

String

企业项目ID。

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地址。当实例开启了公网访问,实例才包含该参数。

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

云监控版本。

响应示例

{
	"name": "kafka-1823069716",
	"engine": "kafka",
	"port": 9093,
	"status": "RUNNING",
	"type": "cluster",
	"specification": "100MB",
	"engine_version": "2.3.0",
	"connect_address": "192.168.0.24,192.168.0.105,192.168.0.103",
	"instance_id": "abbc2f59-7c67-4ca4-8493-cef0624e0d45",
	"resource_spec_code": "dms.instance.kafka.cluster.c3.mini",
	"charging_mode": 1,
	"vpc_id": "1511c95c-540c-42b7-ae78-72fdb3502dc4",
	"vpc_name": "vpc-111",
	"created_at": "1586761206802",
	"product_id": "00300-30308-0--0",
	"security_group_id": "0b605722-22ce-4727-bde8-e5366aff941d",
	"security_group_name": "sg-Kafka",
	"subnet_id": "f8f80ddd-09f7-4f79-a702-3d5f74f215a3",
	"subnet_name": "subnet-111",
	"subnet_cidr": "192.168.0.0/24",
	"available_zones": ["xxx"],
	"user_id": "5f94abe9222e4d05a98986c348ee8afa",
	"user_name": "hby-zwx822581",
	"access_user": "kafka-1823069716",
	"maintain_begin": "22:00:00",
	"maintain_end": "02:00:00",
	"storage_space": 492,
	"total_storage_space": 600,
	"used_storage_space": 25,
	"partition_num": "300",
	"enable_publicip": true,
	"ssl_enable": true,
	"public_connect_address": "10.185.73.68:9095,10.185.73.75:9095,10.185.74.250:9095",
	"storage_resource_id": "3666e27b-4a6e-4237-8531-c1f8851eedcd",
	"storage_spec_code": "dms.physical.storage.high",
	"service_type": "advanced",
	"storage_type": "hec",
	"retention_policy": "produce_reject",
	"kafka_public_status": "true",
	"public_bandwidth": 6
}

状态码

操作成功的状态码如表3所示,其他响应见状态码

表3 状态码

状态码

描述

200

查询指定实例成功。