查询指定指标的 Top 数据和同一个维度下其他指标的数据。

使用限制

一个主账号及该账号下的 IAM 账号，1 秒内调用GetTopData接口的次数不超过 10 次，否则将触发限流。

请求说明

云监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://cloudmonitor.cn-beijing.volcengineapi.com?Action=GetTopData&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetTopData	接口名称。当前 API 的名称为 GetTopData。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
StartTime	Integer	是	1679395680	查询的时间选段的开始时间，秒级时间戳，例如1632904500。
EndTime	Integer	是	1679482080	查询的时间选段的结束时间，秒级时间戳，例如1632904801。注意时间选段的间隔不能超过一天，即EndTime-StartTime <= 1 day。
Namespace	String	是	VCM_NAT	要查询的指标所属的产品空间。参见云监控指标查询下各产品的 Namespace。
SubNamespace	String	是	client	要查询的指标所属的维度。SubNamespace 在不同 Namespace 下的可选值不同，参见云监控指标查询下各产品的 SubNamespace。
MetricNames	Array of String	是	["client_out_bps","client_in_bps","client_conns","client_cps"]	要查询的所有监控指标的名称。注意最多可查询指标数为 4 个。所有指标必须在同一产品空间的同一维度下。
Instances	Array of Instance	是	-	要查询的监控指标信息。
GroupBy	Array of String	是	["ResourceID","ClientIP"]	要查询的监控指标的分组标识，用于多个监控指标结果的关联，可选范围为查询所有指标的公共Dimension。
OrderByMetricName	String	否	-	查询表格时所使用的排序指标。OrderByMetricName在不同的表格下的可选值不同，参见各产品的表格配置。若未指定OrderByMetricName，则使用表格首个指标数据列进行排序。
TopN	Integer	是	2	查询排序指标的 Top 数，必须为正整数。当Asc为true时，查询排序指标最小 N 组数据。当Asc为false时，查询排序指标最大 N 组数据。
Asc	Boolean	否	true	查询表格时对于排序指标的排序方向。 true：升序 false（默认）：降序

Instance

参数	类型	是否必选	示例值	描述
Dimensions	Array of Dimension	是	-	要查询的指标维度。参见云监控指标查询下各产品的 Dimensions。每个 Dimension 里只包含一组 KV。存在多个 Dimension 时，Dimension 和 Dimension 之间的逻辑关系是 and。

Dimension

参数	类型	是否必选	示例值	描述
Name	String	是	ResourceID	检索指标的 KEY。
Value	String	是	eip-13fxxxx	对应 KEY 的值。

请求示例

返回参数

参数	类型	示例值	描述
Data	Object of TopNData	-	符合查询条件的事件详情。

TopNData

参数	类型	示例值	描述
Asc	Boolean	false	查询使用的排序顺序。
TopDataResults	Array of GroupMetricData	-	查询结果。
OrderByMetricName	String	client_out_bps	查询时所使用的排序指标。

GroupMetricData

参数	类型	示例值	描述
GroupKeys	JSON Map	{"ClientIP":"...", "ResourceID":"ngw*****1w1f"}	查询结果中每个分组的标识数据，对应请求参数中GroupBy指定的Dimension查询结果。
MetricData	JSON Map		查询结果中每个分组的指标查询结果，对应请求参数中MetricNames指定指标的查询结果。

TagSet

参数	类型	示例值	描述
key	String	ClientIP	检索指标的 KEY。
value	String	10...106	对应 KEY 的值。

MetricData

参数	类型	示例值	描述
key	String	client_conns	检索指标的 KEY。
value	Any	1	对应 KEY 的值。

返回示例

错误码

本接口无特有的错误码。更多信息请参见错误码。

注意事项

下表中的指标当前不支持调用GetTopData接口查询指标数据。

Namespace	SubNamespace	MetricNames	Description
VCM_Redis	aggregated_proxy	AggregatedNetworkTransmitThroughput	网络输出速率
		aggregated_proxy	AggregatedNetworkReceiveThroughput	网络输入速率
		aggregated_proxy	AggregatedTotalQps	总QPS
		aggregated_proxy	AggregatedReadQps	读QPS
		aggregated_proxy	AggregatedWriteQps	写QPS
		aggregated_server	AggregatedNetworkTransmitThroughput	网络输出速率
		aggregated_server	AggregatedNetworkReceiveThroughput	网络输入速率
		aggregated_server	AggregatedExpiredKeyPerSec	每秒过期Key数量
		aggregated_server	AggregatedEvictedKeyPerSec	每秒逐出Key数量
		aggregated_server	AggregatedTotalEvictedKey	历史累计逐出Key总数
		aggregated_server	AggregatedKeyHitPerSec	每秒命中Key数量
		aggregated_server	AggregatedKeyMissPerSec	每秒未命中Key数量
		proxy	NetworkTransmitThroughput	网络输出速率
		proxy	NetworkReceiveThroughput	网络输入速率
		proxy	TotalQps	总QPS
		proxy	ReadQps	读QPS
		proxy	WriteQps	写QPS
		server	NetworkTransmitThroughput	网络输出速率
		server	NetworkReceiveThroughput	网络输入速率
		server	ExpiredKeyPerSec	每秒过期Key数量
		server	EvictedKeyPerSec	每秒逐出Key数量
		server	KeyHitPerSec	每秒命中Key数量
		server	KeyMissPerSec	每秒未命中Key数量
		server	GeoSpatialBasedCmdsQps	Geo类命令QPS
		server	HashBasedCmdsQps	Hash类命令QPS
		server	HyperLogLogBasedCmdsQps	Hyperloglog类命令QPS
		server	KeysBasedCmdsQps	Keys类命令QPS
		server	ListBasedCmdsQps	List类命令QPS
		server	PubSubBasedCmdsQps	PubSub类命令QPS
		server	ScriptingBasedCmdsQps	Scripting类命令QPS
		server	SetBasedCmdsQps	Set类命令QPS
		server	SortedSetBasedCmdsQps	SortedSet类命令QPS
		server	StringBasedCmdsQps	String类命令QPS
		server	StreamBasedCmdsQps	Stream类命令QPS
		server	TransactionBasedCmdsQps	Transaction类命令QPS
VCM_RDS_PostgreSQL	engine_monitor	RowsInserted	每秒插入行数
		engine_monitor	RowsUpdated	每秒更新行数
		engine_monitor	RowsDeleted	每秒删除行数
		proxy_monitor	ProxyQPS	QPS
VCM_veDB_MySQL	Pod	InnodbBufferDataReads	InnoDB读取吞吐量
		Pod	InnodbBufferDataWritten	InnoDB写入吞吐量
		Pod	InnodbOsDataReads	InnoDB文件读取频率
		Pod	InnodbOsDataWrites	InnoDB文件写入频率
		Pod	InnodbLogWriteRequests	InnoDB日志写请求频率
		Pod	InnodbLogWrites	InnoDB日志物理写频率
		Pod	InnodbLogFsyncs	InnoDB日志fsync写频率
		Pod	CreateTempTableUtil	临时表创建速率
VCM_veDB_PostgreSQL	Instance	TPS	TPS
		Instance	WalWriteQPS	WAL日志写入QPS
		Pod	PageReadQPS	存储层页面读取QPS
		Pod	LongTransactionNum	慢查询个数
		Pod	ReadonlySelectQPS	只读查询QPS
VCM_ESCloud	operation	DeletedDocumentRate	Delete文档频度
		operation	IndexOps	Index操作OPS
		operation	QueryOps	Query操作OPS
		operation	UpdateOps	Update操作OPS
		operation	MergeOps	Merge操作OPS
VCM_HBase	Cluster	ClusterNetworkTransmitThroughput	网络输出速率
		Cluster	ClusterQps	QPS
		Cluster	ClusterNetworkReceiveThroughput	网络输入速率
		Cluster	ClusterTps	TPS
		RegionServer	NetworkTransmitThroughput	网络输出速率
		RegionServer	Qps	QPS
		RegionServer	BlockCacheHitRate	BlockCache命中率
		RegionServer	Tps	TPS
		RegionServer	NetworkReceiveThroughput	网络输入速率
		RegionServer	AvgRpcCallRt	RPC请求的平均响应时间
		RegionServer	MaxRpcCallRT	RPC请求的最大响应时间
VCM_BMQ	topic	inf_bmq_produce_ProducerStatsPerTopicPartition_Count	生产请求QPS
		topic	inf_bmq_proxy_fetchRequest	消费请求QPS
		topic	inf_bmq_server_io_MessagesInPerSec_Count	生产请求条数
		topic	inf_bmq_proxy_fetchMessage	消费消息条数
		topic	inf_bmq_proxy_bytes_in	生产消息流量
		topic	inf_bmq_proxy_bytes_out	消费消息流量
		ConsumerGroup_Topic	inf_bmq_group_offset	单个Topic的消费条数
VCM_veGraph_db	Instance	TotalQps	总QPS
VCM_veGraph_db		Pod	Throughput	吞吐量
VCM_DTS	basic_monitoring	FullTransmissionRps	全量传输RPS
VCM_veDB_MySQL	Pod	SlowQueries	慢查询数
		Pod	SelectScan	全表扫描数
		Pod	OperationUpdate	更新数
		Pod	InnodbRowsUpdated	Innodb行更新量
		Pod	OperationDelete	删除数
		Pod	InnodbRowsDeleted	Innodb行删除量
		Pod	OperationInsert	插入数
		Pod	InnodbRowsInserted	Innodb行插入量
		Pod	OperationReplace	覆盖数
		Pod	OperationCommit	提交数
		Pod	HandlerCommit	内部提交数
		Pod	OperationRollback	回滚数
		Pod	HandlerRollback	内部回滚数
		Pod	TableLocksWaited	等待表锁次数
		Pod	InnodbRowLockWaits	Innodb等待行锁次数
		Pod	CreatedTmpFiles	临时文件数量
		Pod	CreatedTmpDiskTables	磁盘临时表数量
		Pod	HandlerReadRndNext	读下一行请求数
		Pod	InnodbBufferPoolReadRequests	Innodb逻辑读
		Pod	InnodbBufferPoolReads	Innodb物理读
VCM_EMR	Doris	DorisBENodeBytesReadRate	BE节点读取速度
		Doris	DorisBENodeBytesWriteRate	BE节点写入速度
		Doris	DorisBENodeIOTimes	BE节点IO耗时
		Pulsar	BookkeeperServerAddEntryRequestSuccessRate	Bookkeeper ADD_ENTRY请求成功率
		Pulsar	BookkeeperServerReadEntryRequestSuccessRate	Bookkeeper READ_ENTRY 请求成功率
		Pulsar	BookkeeperServerAddEntryOperateSuccessRate	Bookkeeper ADD_ENTRY 操作速度
		Pulsar	BookkeeperServerReadEntryOperateSuccessRate	Bookkeeper READ_ENTRY 操作速度
		Pulsar	BookkeeperServerAddEntryRequestRate	Bookkeeper ADD_ENTRY 请求速度
		Pulsar	BookkeeperServerReadEntryRequestRate	Bookkeeper READ_ENTRY 请求速度
VCM_CFS	DanceDN	bytestore_chunkserver_block_receiver_receive_bytes	写入带宽
		DanceDN	bytestore_chunkserver_block_sender_send_bytes	读取带宽
		DanceDN	bytestore_chunkserver_data_xceiver_write_num	写入QPS
		DanceDN	bytestore_chunkserver_data_xceiver_read_num	读取QPS
		DanceDN	bytestore_chunkserver_tos_store_upload_throughput	对象存储写upload带宽
		DanceDN	bytestore_chunkserver_tos_store_read_throughput	对象存储读带宽
		DanceDN	bytestore_chunkserver_tos_store_put_object_throughput	对象存储写put带宽
		DanceDN	bytestore_chunkserver_tos_store_object_throughput	HDFS模式对象存储写带宽
		DanceDN	bytestore_chunkserver_tos_store_acc_upload_throughput	透明加速模式对象存储写带宽

错误码

本接口无特有的错误码。更多信息请参见错误码。