文档中心

GetTopData

最近更新时间：2024.03.12 16:52:17

首次发布时间：2023.04.21 10:10:22

调用GetTopData接口查询指定指标的Top数据和同一个维度下的的其他指标的数据。

使用限制

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

Request URL

POST https://open.volcengineapi.com?Action=GetTopData&Version=2018-01-01

ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

请求参数

参数	类型	是否必填	示例值	描述
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	是	`["client_out_bps",` `"client_in_bps",` `"client_conns",` `"client_cps"]`	要查询的所有监控指标的名称。注意最多可查询指标数为4个。所有指标必须在同一产品空间的同一维度下。
Instances	Array	是	-	要查询的监控指标信息。详情请参见Instance请求参数。
GroupBy	Array	是	`["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	是	-	要查询的指标维度。详情请参见Dimension请求参数。

Dimension请求参数

参数	类型	是否必填	示例值	描述
Name	String	是	`ResourceID`	检索指标的KEY，例如：ResourceID。
Value	String	是	`ngw*****1w1f`	对应KEY的值，例如：instance-123。

返回数据

参数	类型	示例值	描述
OrderByMetricName	String	`client_out_bps`	查询时所使用的排序指标。
Asc	Boolean	`false`	查询使用的排序顺序。
TopDataResults	Array	-	查询结果。详情请参见TopDataResult数据结构。

TopDataResult数据结构

参数	类型	示例值	描述
GroupKeys	Object	`{"ClientIP":"...",` `"ResourceID":"ngw*****1w1f"}`	查询结果中每个分组的标识数据，对应请求参数中GroupBy指定的Dimension的查询结果。
MetricData	Object	`{"client_conns":2.666448230668414,` `"client_cps":0.02404980340760158,` `"client_in_bps":6061.495849716029,` `"client_out_bps":6514.217038007857` `}`	查询结果中每个分组的指标查询结果，对应请求参数中MetricNames指定的指标的查询结果。

请求示例

POST https://open.volcengineapi.com?Action=GetTopData&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "Namespace":"VCM_NAT",
    "SubNamespace":"client",
    "MetricNames":[
        "client_out_bps",
        "client_in_bps",
        "client_conns",
        "client_cps"
    ],
    "StartTime":1679395680,
    "EndTime":1679482080,
    "Instances":[
        {
            "Dimensions":[
                {
                    "Name":"ResourceID",
                    "Value":"ngw*****1w1f"
                }
            ]
        }
    ],
    "GroupBy":[
        "ResourceID",
        "ClientIP"
    ],
    "TopN":2,
    "Region":"cn-ningbo-sdv"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20230*****44C52",
        "Action":"GetTopData",
        "Version":"2018-01-01",
        "Service":"Volc_Observe",
        "Region":"cn-beijing"
    },
    "Result":{
        "OrderByMetricName":"client_out_bps",
        "Asc":false,
        "TopDataResults":[
            {
                "GroupKeys":{
                    "ClientIP":"10.**.**.105",
                    "ResourceID":"ngw*****1w1f"
                },
                "MetricData":{
                    "client_conns":2.666448230668414,
                    "client_cps":0.02404980340760158,
                    "client_in_bps":6061.495849716029,
                    "client_out_bps":6514.217038007857
                }
            },
            {
                "GroupKeys":{
                    "ClientIP":"10.**.**.106",
                    "ResourceID":"ngw*****1w1f"
                },
                "MetricData":{
                    "client_conns":1,
                    "client_cps":0.00012138868657441125,
                    "client_in_bps":5906.8803107550375,
                    "client_out_bps":5907.487448409809
                }
            }
        ]
    }
}

注意事项

下表中的指标当前不支持调用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	透明加速模式对象存储写带宽

使用限制

Request URL

Header

请求参数

返回数据

请求示例

返回示例

注意事项

云监控

GetTopData

使用限制

Request URL

Header

请求参数

Instance请求参数

Dimension请求参数

返回数据

TopDataResult数据结构

请求示例

返回示例

注意事项