You need to enable JavaScript to run this app.
导航
GetTopData
最近更新时间:2024.09.24 11:27:32首次发布时间:2023.04.21 10:10:22

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

使用限制

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=GetTopData&Version=2018-01-01
ServiceName : Volc_Observe 
Region : cn-beijing 
AccessKey : xxx 
SecretKey : xxx

调试

请求参数

Query

参数类型是否必选示例值描述
ActionStringGetTopData接口名称。当前 API 的名称为 GetTopData
VersionString2018-01-01接口版本。当前 API 的版本为 2018-01-01

Body

参数类型是否必选示例值描述
StartTimeInteger1679395680查询的时间选段的开始时间,秒级时间戳,例如1632904500。

EndTime

Integer

1679482080

查询的时间选段的结束时间,秒级时间戳,例如1632904801。

注意

时间选段的间隔不能超过一天,即EndTime-StartTime <= 1 day

NamespaceStringVCM_NAT要查询的指标所属的产品空间。参见云产品监控指标下各产品的Namespace
SubNamespaceStringclient要查询的指标所属的维度。SubNamespace在不同Namespace下的可选值不同,参见云产品监控指标下各产品的SubNamespace

MetricNames

Array of String

["client_out_bps","client_in_bps","client_conns","client_cps"]

要查询的所有监控指标的名称。

注意

  • 最多可查询指标数为4个。
  • 所有指标必须在同一产品空间的同一维度下。
InstancesArray of Instance-要查询的监控指标信息。
GroupByArray 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

参数类型是否必选示例值描述
NameStringResourceID检索指标的KEY。
ValueStringeip-13fxxxx对应KEY的值。

返回参数

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

TopNData

参数类型示例值描述
OrderByMetricNameStringclient_out_bps查询时所使用的排序指标。
AscBooleanfalse查询使用的排序顺序。
TopDataResultsArray of GroupMetricData-查询结果。

GroupMetricData

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

GroupKeys

参数类型示例值描述
keyStringClientIP检索指标的KEY。
valueString10.**.**.106对应KEY的值。

MetricData

参数类型示例值描述
keyStringclient_conns检索指标的KEY。
valueAny1对应KEY的值。

请求示例

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接口查询指标数据。

NamespaceSubNamespaceMetricNamesDescription
VCM_Redisaggregated_proxyAggregatedNetworkTransmitThroughput网络输出速率
aggregated_proxyAggregatedNetworkReceiveThroughput网络输入速率
aggregated_proxyAggregatedTotalQps总QPS
aggregated_proxyAggregatedReadQps读QPS
aggregated_proxyAggregatedWriteQps写QPS
aggregated_serverAggregatedNetworkTransmitThroughput网络输出速率
aggregated_serverAggregatedNetworkReceiveThroughput网络输入速率
aggregated_serverAggregatedExpiredKeyPerSec每秒过期Key数量
aggregated_serverAggregatedEvictedKeyPerSec每秒逐出Key数量
aggregated_serverAggregatedTotalEvictedKey历史累计逐出Key总数
aggregated_serverAggregatedKeyHitPerSec每秒命中Key数量
aggregated_serverAggregatedKeyMissPerSec每秒未命中Key数量
proxyNetworkTransmitThroughput网络输出速率
proxyNetworkReceiveThroughput网络输入速率
proxyTotalQps总QPS
proxyReadQps读QPS
proxyWriteQps写QPS
serverNetworkTransmitThroughput网络输出速率
serverNetworkReceiveThroughput网络输入速率
serverExpiredKeyPerSec每秒过期Key数量
serverEvictedKeyPerSec每秒逐出Key数量
serverKeyHitPerSec每秒命中Key数量
serverKeyMissPerSec每秒未命中Key数量
serverGeoSpatialBasedCmdsQpsGeo类命令QPS
serverHashBasedCmdsQpsHash类命令QPS
serverHyperLogLogBasedCmdsQpsHyperloglog类命令QPS
serverKeysBasedCmdsQpsKeys类命令QPS
serverListBasedCmdsQpsList类命令QPS
serverPubSubBasedCmdsQpsPubSub类命令QPS
serverScriptingBasedCmdsQpsScripting类命令QPS
serverSetBasedCmdsQpsSet类命令QPS
serverSortedSetBasedCmdsQpsSortedSet类命令QPS
serverStringBasedCmdsQpsString类命令QPS
serverStreamBasedCmdsQpsStream类命令QPS
serverTransactionBasedCmdsQpsTransaction类命令QPS
VCM_RDS_PostgreSQLengine_monitorRowsInserted每秒插入行数
engine_monitorRowsUpdated每秒更新行数
engine_monitorRowsDeleted每秒删除行数
proxy_monitorProxyQPSQPS
VCM_veDB_MySQLPodInnodbBufferDataReadsInnoDB读取吞吐量
PodInnodbBufferDataWrittenInnoDB写入吞吐量
PodInnodbOsDataReadsInnoDB文件读取频率
PodInnodbOsDataWritesInnoDB文件写入频率
PodInnodbLogWriteRequestsInnoDB日志写请求频率
PodInnodbLogWritesInnoDB日志物理写频率
PodInnodbLogFsyncsInnoDB日志fsync写频率
PodCreateTempTableUtil临时表创建速率
VCM_veDB_PostgreSQLInstanceTPSTPS
InstanceWalWriteQPSWAL日志写入QPS
PodPageReadQPS存储层页面读取QPS
PodLongTransactionNum慢查询个数
PodReadonlySelectQPS只读查询QPS
VCM_ESCloudoperationDeletedDocumentRateDelete文档频度
operationIndexOpsIndex操作OPS
operationQueryOpsQuery操作OPS
operationUpdateOpsUpdate操作OPS
operationMergeOpsMerge操作OPS
VCM_HBaseClusterClusterNetworkTransmitThroughput网络输出速率
ClusterClusterQpsQPS
ClusterClusterNetworkReceiveThroughput网络输入速率
ClusterClusterTpsTPS
RegionServerNetworkTransmitThroughput网络输出速率
RegionServerQpsQPS
RegionServerBlockCacheHitRateBlockCache命中率
RegionServerTpsTPS
RegionServerNetworkReceiveThroughput网络输入速率
RegionServerAvgRpcCallRtRPC请求的平均响应时间
RegionServerMaxRpcCallRTRPC请求的最大响应时间
VCM_BMQtopicinf_bmq_produce_ProducerStatsPerTopicPartition_Count生产请求QPS
topicinf_bmq_proxy_fetchRequest消费请求QPS
topicinf_bmq_server_io_MessagesInPerSec_Count生产请求条数
topicinf_bmq_proxy_fetchMessage消费消息条数
topicinf_bmq_proxy_bytes_in生产消息流量
topicinf_bmq_proxy_bytes_out消费消息流量
ConsumerGroup_Topicinf_bmq_group_offset单个Topic的消费条数
VCM_veGraph_dbInstanceTotalQps总QPS
PodThroughput吞吐量
VCM_DTSbasic_monitoringFullTransmissionRps全量传输RPS
VCM_veDB_MySQLPodSlowQueries慢查询数
PodSelectScan全表扫描数
PodOperationUpdate更新数
PodInnodbRowsUpdatedInnodb行更新量
PodOperationDelete删除数
PodInnodbRowsDeletedInnodb行删除量
PodOperationInsert插入数
PodInnodbRowsInsertedInnodb行插入量
PodOperationReplace覆盖数
PodOperationCommit提交数
PodHandlerCommit内部提交数
PodOperationRollback回滚数
PodHandlerRollback内部回滚数
PodTableLocksWaited等待表锁次数
PodInnodbRowLockWaitsInnodb等待行锁次数
PodCreatedTmpFiles临时文件数量
PodCreatedTmpDiskTables磁盘临时表数量
PodHandlerReadRndNext读下一行请求数
PodInnodbBufferPoolReadRequestsInnodb逻辑读
PodInnodbBufferPoolReadsInnodb物理读
VCM_EMRDorisDorisBENodeBytesReadRateBE节点读取速度
DorisDorisBENodeBytesWriteRateBE节点写入速度
DorisDorisBENodeIOTimesBE节点IO耗时
PulsarBookkeeperServerAddEntryRequestSuccessRateBookkeeper ADD_ENTRY请求成功率
PulsarBookkeeperServerReadEntryRequestSuccessRateBookkeeper READ_ENTRY 请求成功率
PulsarBookkeeperServerAddEntryOperateSuccessRateBookkeeper ADD_ENTRY 操作速度
PulsarBookkeeperServerReadEntryOperateSuccessRateBookkeeper READ_ENTRY 操作速度
PulsarBookkeeperServerAddEntryRequestRateBookkeeper ADD_ENTRY 请求速度
PulsarBookkeeperServerReadEntryRequestRateBookkeeper READ_ENTRY 请求速度
VCM_CFSDanceDNbytestore_chunkserver_block_receiver_receive_bytes写入带宽
DanceDNbytestore_chunkserver_block_sender_send_bytes读取带宽
DanceDNbytestore_chunkserver_data_xceiver_write_num写入QPS
DanceDNbytestore_chunkserver_data_xceiver_read_num读取QPS
DanceDNbytestore_chunkserver_tos_store_upload_throughput对象存储写upload带宽
DanceDNbytestore_chunkserver_tos_store_read_throughput对象存储读带宽
DanceDNbytestore_chunkserver_tos_store_put_object_throughput对象存储写put带宽
DanceDNbytestore_chunkserver_tos_store_object_throughputHDFS模式对象存储写带宽
DanceDNbytestore_chunkserver_tos_store_acc_upload_throughput透明加速模式对象存储写带宽