文档首页/ 分布式消息服务Kafka版/ API参考/ 历史API/ API V1/ 其他接口/ 查询实例在CES的监控层级关系
更新时间:2024-01-30 GMT+08:00
分享

查询实例在CES的监控层级关系

当前页面API为历史版本API,未来可能停止维护。请使用查询实例在CES的监控层级关系

URI

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

参数说明见表1

表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

instance_id

String

实例ID。

请求消息

请求参数

请求示例

响应消息

响应参数

参数说明见表2

表2 响应参数说明

参数

类型

说明

dimensions

Array of object dimensions

监控维度。参数参考表3

instance_ids

Array of object instance_ids

实例信息。参数参考表4

nodes

Array of object nodes

节点信息。参数参考表5

queues

Array of object queues

队列信息。参数参考表6

groups

Array of object groups

消费组信息。参数参考表7

表3 dimensions参数说明

参数

类型

说明

name

String

监控维度名称。

metrics

Array of object metrics

监控指标名称。参数参考表10

key_name

Array of object key_name

监控查询使用的key。

dim_router

Array of object dim_router

监控维度路由。

children

Array of object children

子维度列表。参数参考表8

表4 instance_ids参数说明

参数

类型

说明

name

String

实例ID。

表5 nodes参数说明

参数

类型

说明

name

String

节点名称。

表6 queues参数说明

参数

类型

说明

name

String

topic名称。

partitions

Array of object partitions

分区列表。参数参见表9

表7 groups参数说明

参数

类型

说明

name

String

消费组名称。

queues

Array of object queues

队列信息。

表8 children参数说明

参数

类型

说明

name

String

子维度名称。

metrics

Array of String

监控指标名称列表。参数参见表10

key_name

Array of String

监控查询使用的key。

dim_router

Array of String

监控维度路由

表9 partitions参数说明

参数

类型

说明

name

String

分区id

表10 metrics说明

维度

指标ID

说明

kafka_instance_id

(kafka实例维度)

current_topics

topic个数

current_partitions

分区个数

group_messages

消费组堆积消息数

kafka_broker(kafka节点维度)

broker_data_size

节点数据容量

broker_messages_in_rate

消息生产速率,每秒生产的消息数量

broker_bytes_out_rate

消费流量,每秒消费的字节数

broker_bytes_in_rate

生产流量,每秒生产的字节数

broker_public_bytes_in_rate

公网入流量,每秒节点公网访问流入流量

broker_public_bytes_out_rate

公网出流量,每秒节点公网访问流出流量

broker_produce_mean

消息生产平均处理时长,服务端处理消息生产请求平均时长

broker_fetch_mean

消息消费平均处理时长,服务端处理消息消费请求平均时长

kafka_topics(kafka topic维度)

topic_data_size

队列数据容量,当前队列的数据容量

topic_messages_in_rate

消息生产速率,每秒钟生产的消息数量

topic_bytes_out_rate

消费流量,每秒钟消费的字节数

topic_bytes_in_rate

生产流量,每秒钟生产的字节数

topic_messages

队列消息总数,当前队列的总消息数

kafka_partitions(kafka分区维度)

produced_messages

生产消息数,已经生产的消息数

partition_messages

分区消息数,分区当前的消息数

messages_consumed

分区已消费消息数,当前消费组已经消费的消息个数

messages_remained

分区剩余可消费数,消费组剩余可消费的消息个数

kafka_groups_partitions(kafka消费组维度)

messages_consumed

分区已消费消息数,当前消费组已经消费的消息个数

messages_remained

分区剩余可消费消息数,当前消费组剩余可消费的消息个数

响应示例

{
	"dimensions": [{
		"name": "kafka_instance_id",
		"metrics": ["current_partitions",
		"current_topics",
		"group_messages"],
		"key_name": ["instance_ids"],
		"dim_router": ["kafka_instance_id"]
	},
	{
		"name": "kafka_broker",
		"metrics": ["broker_data_size",
		"broker_messages_in_rate",
		"broker_bytes_out_rate",
		"broker_bytes_in_rate",
		"broker_produce_mean",
		"broker_fetch_mean"],
		"key_name": ["nodes"],
		"dim_router": ["kafka_instance_id",
		"kafka_broker"]
	},
	{
		"name": "kafka_rest",
		"metrics": ["rest_produce_success",
		"rest_produce_failed",
		"rest_produce_latency",
		"rest_produce_msg_num",
		"rest_produce_flow",
		"rest_consume_success",
		"rest_consume_failed",
		"rest_consume_latency",
		"rest_consume_msg_num",
		"rest_consume_flow",
		"rest_commit_success",
		"rest_commit_failed",
		"rest_commit_latency",
		"rest_commit_msg_num",
		"rest_commit_flow"],
		"key_name": ["nodes"],
		"dim_router": ["kafka_instance_id",
		"kafka_rest"]
	},
	{
		"name": "kafka_topics",
		"metrics": ["topic_data_size",
		"topic_messages_in_rate",
		"topic_bytes_out_rate",
		"topic_bytes_in_rate",
		"topic_messages"],
		"key_name": ["queues"],
		"dim_router": ["kafka_instance_id",
		"kafka_topics"],
		"children": [{
			"name": "kafka_partitions",
			"metrics": ["produced_messages",
			"partition_messages"],
			"key_name": ["queues",
			"partitions"],
			"dim_router": ["kafka_instance_id",
			"kafka_topics",
			"kafka_partitions"]
		}]
	},
	{
		"name": "kafka_groups_partitions",
		"metrics": ["messages_consumed",
		"messages_remained"],
		"key_name": ["groups",
		"queues",
		"partitions"],
		"dim_router": ["kafka_instance_id",
		"kafka_groups",
		"kafka_groups_topics",
		"kafka_groups_partitions"]
	}],
	"instance_ids": [{
		"name": "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7"
	}],
	"nodes": [{
		"name": "broker-0"
	},
	{
		"name": "broker-1"
	},
	{
		"name": "broker-2"
	}],
	"queues": [{
		"name": "aaaa",
		"partitions": [{
			"name": "0"
		}]
	},
	{
		"name": "mytest",
		"partitions": [{
			"name": "0"
		},
		{
			"name": "1"
		},
		{
			"name": "2"
		}]
	},
	{
		"name": "topic-84234378",
		"partitions": [{
			"name": "0"
		},
		{
			"name": "1"
		},
		{
			"name": "2"
		}]
	}],
	"groups": [{
		"name": "test-consumer-group",
		"queues": [{
			"name": "mytest",
			"partitions": [{
				"name": "0"
			},
			{
				"name": "1"
			},
			{
				"name": "2"
			}]
		}]
	}]
}

状态码

查询成功的状态码如表11所示,其他响应见表1

表11 状态码

状态码

描述

200

查询成功。

相关文档