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

使用限制

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

请求说明

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

调试

请求参数

Instance

Dimension

请求示例

POST https://open.volcengineapi.com?Action=GetTopData&Version=2018-01-01
Content-Type: application/json
{
    "Namespace": "VCM_NAT",
    "SubNamespace": "client",
    "StartTime": 1679395680,
    "EndTime": 1679482080,
    "TopN": 2,
    "Asc": true,
    "GroupBy": [
        "ResourceID",
        "ClientIP"
    ],
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "ResourceID",
                    "Value": "eip-13fxxxx"
                }
            ]
        }
    ],
    "MetricNames": [
        "client_out_bps",
        "client_in_bps",
        "client_conns",
        "client_cps"
    ]
}

返回参数

TopNData

GroupMetricData

GroupKeys

MetricData

返回示例

{
    "ResponseMetadata": {
        "Action": "GetTopData",
        "Region": "cn-beijing",
        "Service": "volc_observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": {
            "Asc": false,
            "OrderByMetricName": "client_out_bps",
            "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接口查询指标数据。