You need to enable JavaScript to run this app.
导航
获取数据指标列表
最近更新时间:2024.12.16 14:13:48首次发布时间:2024.05.09 10:16:53

调用本接口获取告警策略支持的所有数据指标。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制

使用限制

节流限制:您每秒最多可以提交 30 个 API 请求。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=ListAlertMetaMetrics&Version=2022-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
接口名称。当前 API 的名称为 ListAlertMetaMetrics
Version
String
接口版本。当前 API 的版本为 2022-03-01

Body

参数名称
数据类型
是否必选
参数说明
示例
PagingOption
Object
对查询结果进行分页并返回特定页码上的指标。

返回参数

参数名称
数据类型
参数说明
示例
Data
Object[]
指标详情。
Pagination
Object
分页信息。

请求示例

POST https://open.volcengineapi.com/?Action=ListAlertMetaMetrics&Version=2022-03-01
{
    "PagingOption":{
        "PageSize": 0,
        "PageNum": 1
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20240508142620FFDF0F841BDD0CC0679F",
        "Action": "ListAlertMetaMetrics",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "Name": "分实例统计",
                "Children": [
                    {
                        "Id": "308048891272724480",
                        "Name": "TCP可用率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Tcp"
                    },
                    {
                        "Id": "308048810737893376",
                        "Name": "DNS可用率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Dns"
                    },
                    {
                        "Id": "308048692106199040",
                        "Name": "Ping可用率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Ping"
                    },
                    {
                        "Id": "308048518965329920",
                        "Name": "可用率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "301461987718823936",
                        "Name": "TCP接收用时",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Tcp"
                    },
                    {
                        "Id": "301461826917597184",
                        "Name": "TCP响应用时",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Tcp"
                    },
                    {
                        "Id": "301461550793981952",
                        "Name": "TCP连接用时",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Tcp"
                    },
                    {
                        "Id": "301461002229350400",
                        "Name": "TCP时延",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Tcp"
                    },
                    {
                        "Id": "301460707227172864",
                        "Name": "DNS时延",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Dns"
                    },
                    {
                        "Id": "301459902910660608",
                        "Name": "Ping丢包率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Ping"
                    },
                    {
                        "Id": "301458876186984448",
                        "Name": "Ping时延",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Ping"
                    },
                    {
                        "Id": "301455417287081984",
                        "Name": "重定向时间",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "300589042742034432",
                        "Name": "下载速度",
                        "TriggerType": "Threshold",
                        "Format": [
                            "B/s",
                            "KB/s",
                            "MB/s"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "300585206929391616",
                        "Name": "首包时间",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "300584818046107648",
                        "Name": "建连时间",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "300584420174430208",
                        "Name": "SSL时延",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "300309530053672960",
                        "Name": "整体性能",
                        "TriggerType": "Threshold",
                        "Format": [
                            "MilliSecond",
                            "Second"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ],
                        "ProtocolType": "Http"
                    },
                    {
                        "Id": "263460620136054784",
                        "Name": "内容管理任务执行失败",
                        "TriggerType": "Event",
                        "Format": [
                            "count"
                        ],
                        "SupportAlgo": [
                            "Callback"
                        ]
                    },
                    {
                        "Id": "234264782419615744",
                        "Name": "证书有效期",
                        "TriggerType": "Threshold",
                        "Format": [
                            "Day"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215852069872173056",
                        "Name": "请求数命中率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215851329208418304",
                        "Name": "流量命中率",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215804880215048192",
                        "Name": "回源QPS",
                        "TriggerType": "Threshold",
                        "Format": [
                            "count/s"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215804127878545408",
                        "Name": "访问QPS",
                        "TriggerType": "Threshold",
                        "Format": [
                            "count/s"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215803523231875072",
                        "Name": "回源请求数",
                        "TriggerType": "Threshold",
                        "Format": [
                            "count"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215803288359239680",
                        "Name": "访问请求数",
                        "TriggerType": "Threshold",
                        "Format": [
                            "count"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215801523924598784",
                        "Name": "回源流量",
                        "TriggerType": "Threshold",
                        "Format": [
                            "B",
                            "KB",
                            "MB",
                            "GB",
                            "TB"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215801401450921984",
                        "Name": "访问流量",
                        "TriggerType": "Threshold",
                        "Format": [
                            "B",
                            "KB",
                            "MB",
                            "GB",
                            "TB"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215800173631340544",
                        "Name": "回源带宽",
                        "TriggerType": "Threshold",
                        "Format": [
                            "bps",
                            "Kbps",
                            "Mbps",
                            "Gbps",
                            "Tbps"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215799857556979712",
                        "Name": "访问带宽",
                        "TriggerType": "Threshold",
                        "Format": [
                            "bps",
                            "Kbps",
                            "Mbps",
                            "Gbps",
                            "Tbps"
                        ],
                        "SupportAlgo": [
                            "Static"
                        ]
                    },
                    {
                        "Id": "215794073100058624",
                        "Name": "回源状态码5xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215794037238759424",
                        "Name": "回源状态码4xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215793937192026112",
                        "Name": "回源状态码3xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215793887372083200",
                        "Name": "回源状态码2xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215793706572414976",
                        "Name": "访问状态码3xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215793643431362560",
                        "Name": "访问状态码2xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215792852423376896",
                        "Name": "访问状态码5xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    },
                    {
                        "Id": "215792790880354304",
                        "Name": "访问状态码4xx占比",
                        "TriggerType": "Threshold",
                        "Format": [
                            "percent"
                        ],
                        "SupportAlgo": [
                            "Static",
                            "Dynamic"
                        ]
                    }
                ]
            }
        ],
        "Pagination": {
            "PageSize": 0,
            "PageNum": 1,
            "Total": 37
        }
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见错误码