GetTopData

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

使用限制

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

请求说明

• 请求方式：POST
• 请求地址：https://open.volcengineapi.com?Action=GetTopData&Version=2018-01-01

Header

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

调试

请求参数

Query

Body

Instance

Dimension

返回参数

TopNData

GroupMetricData

请求示例

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