You need to enable JavaScript to run this app.
导航

查询访问实时监控

最近更新时间2023.10.26 15:53:44

首次发布时间2021.12.27 17:16:07

API说明

API名称:DescribeRealtimeData 。
API域名:open.volcengineapi.com。
API描述:查询域名的实时资源用量数据。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称
是否必选
参数类型
参数说明
Action
String
API 名称,该参数的取值是 DescribeRealtimeData 。
Version
String
API 版本,该参数的取值是 2021-04-01 。

请求正文

参数名称

是否必选

参数类型

参数说明

示例

StartTimeString查询起始时间。2021-01-01 00:00:00
EndTimeString查询结束时间,结束时间大于起始时间。2021-01-01 23:59:59
Domains[ ]String指定查询域名列表,为空代表查询当前用户所有域名。[www.bytedance.com]
ProjectName[ ]String指定查询域名所属的项目,为空代表查询当前用户所有项目。[test]

Metrics

[ ]String

指定查询指标,支持取值:

  • all:全部指标。

  • traffic:流量,单位为 byte 。

  • bandwidth:峰值带宽,单位为 bps 。

  • request: 请求数,单位为次 。

  • QPS: 峰值QPS,单位为次/s 。

  • RequestHitRate:请求数命中率。

  • TrafficHitRate:流量命中率。

  • 2xx:返回 2xx 状态码汇总或者 2 开头状态码数据,单位为个 。

  • 3xx:返回 3xx 状态码汇总或者 3 开头状态码数据,单位为个 。

  • 4xx:返回 4xx 状态码汇总或者 4 开头状态码数据,单位为个 。

  • 5xx:返回 5xx 状态码汇总或者 5 开头状态码数据,单位为个 。

  • ResponseTime:平均响应时间,单位为毫秒。

[bandwidth,2xx]

IspNameEn

[ ]String

指定运营商,为空时表示查询所有运营商,支持参数:

  • unicom

  • telecom

  • mobile

  • guangdian

  • edu

  • tietong

  • pengboshi

  • other

[telecom,mobile]

AcceleratingRegion

String

加速区域,不填表示查询所有区域,支持参数:

  • CHN:中国大陆。

  • EU(白名单可见):欧洲。

  • NA(白名单可见):北美。

  • SA(白名单可见):南美。

  • ME(白名单可见):中东。

  • AP1(白名单可见):亚太1。

  • AP2(白名单可见):亚太2。

  • AP3(白名单可见):亚太3。

AP1

AcceleratingScope

String

加速区域范围,不填表示查询全球范围,支持参数:

  • mainland:中国境内。
  • overseas:中国境外。

mainland

Area

String

客户端所在区域,不填表示查询所有区域,支持参数:

  • China:中国大陆。

  • Global:全球。

Global

Region

[ ]String

指定区域,为空时表示查询所有区域。当 Area为 China 或 Global 时,Region 支持的区域详见下表

[BJ]

Protocol

[ ]String

指定客户端请求应用层和传输层协议查询,为空时表示查询所有协议,支持参数:

  • ALL

  • HTTP

  • HTTPS

  • QUIC

  • WebSocket

[HTTP,HTTPS]

Type

String

指定访问类型,不填时表示查询所有类型,返回总和(相当于all),支持参数:

  • all:所有类型。

  • dynamic:指定查询动态对应指标。

  • static:指定查询静态对应指标。

all

IPVersion

String

指定ip类型查询,不填时表示查询所有类型,支持参数:

  • all:所有类型。

  • ipv4

  • ipv6

all

注意

资源用量和实时监控接口的查询时间区别如下表。

具体指标资源用量实时监控
查询时支持查到的最早历史数据90天前7天前
查询时支持最大的查询时间跨度31天24小时
查询后数据展示的最小时间粒度5分钟(可修改其他更大数值)1分钟(不可修改)
Area 取值对应 Region 的取值范围
China["BJ", "AH", "CQ", "FJ", "GD", "GS", "GX", "GZ", "HA", "HB", "HE", "HI", "HK", "HL", "HN", "JL", "JS", "JX", "LN", "MO", "NM", "NX", "QH", "SC", "SD", "SH", "SN", "SX", "TJ", "TW", "XJ", "XZ", "YN", "ZJ", "OTHERS"]
Global["CHN", "CHE", "AZE", "PNG", "PSE", "FSM", "LVA", "KHM", "SPM", "MYS", "COG", "VNM", "GRD", "HND", "GUF", "WLF", "COK", "BFA", "LAO", "IOT", "SVK", "GUM", "MLI", "RWA", "SGS", "IRN", "BLR", "KEN", "SMR", "BVT", "MSR", "DOM", "GIN", "IMN", "BLZ", "NRU", "NFK", "TZA", "BHR", "LBY", "YEM", "ARE", "SXM", "CPV", "MKD", "HMD", "ZWE", "ESP", "ATG", "BGD", "TKM", "MYT", "IND", "GRC", "SAU", "PHL", "GHA", "ISR", "VGB", "JAM", "TON", "DNK", "TCA", "LBR", "NLD", "PAN", "VCT", "COM", "PYF", "SWE", "CRI", "GTM", "KNA", "TUV", "PAK", "TJK", "DZA", "FIN", "MHL", "SLV", "FJI", "PER", "WSM", "CAF", "ERI", "LSO", "GGY", "MAR", "CYP", "ISL", "GNB", "NOR", "IRQ", "VUT", "AND", "CXR", "JOR", "MEX", "MCO", "NER", "JPN", "FRA", "EST", "VEN", "UMI", "AUS", "PRT", "GIB", "LIE", "ALB", "KOR", "HRV", "MNE", "TUN", "QAT", "SGP", "COL", "CUB", "EGY", "ARG", "CHL", "LCA", "ZAF", "CCK", "NPL", "MTQ", "ATF", "THA", "SRB", "ETH", "SJM", "BDI", "PRK", "GNQ", "BMU", "UKR", "OMN", "SDN", "ZMB", "DEU", "MDG", "AIA", "GUY", "NIC", "GRL", "MMR", "LKA", "BEL", "PRY", "PRI", "MLT", "MNP", "IRL", "ABW", "CYM", "TCD", "CIV", "BRB", "ALA", "BGR", "HTI", "NIU", "COD", "DJI", "TGO", "ASM", "BIH", "KWT", "MWI", "MNG", "SYR", "KAZ", "BEN", "SHN", "UGA", "KIR", "SLE", "AFG", "UZB", "SEN", "REU", "TUR", "URY", "TTO", "NAM", "ITA", "BOL", "PCN", "BWA", "MDV", "VAT", "SSD", "CZE", "MUS", "SOM", "XKS", "SUR", "GBR", "BRA", "JEY", "ECU", "FLK", "NCL", "AGO", "MOZ", "POL", "PLW", "IDN", "SLB", "GMB", "LBN", "MAF", "BHS", "USA", "ARM", "GLP", "BTN", "CUW", "ESH", "ROU", "GEO", "NGA", "LTU", "VIR", "SYC", "ATA", "RUS", "TKL", "GAB", "CAN", "BRN", "STP", "NZL", "CMR", "SWZ", "TLS", "SVN", "LUX", "MDA", "HUN", "FRO", "MRT", "BLM", "AUT", "KGZ", "OTHERS"]
为空全部区域

响应正文

参数名称
参数类型
参数说明
示例
RequestId
String
请求ID。
2021121*****58010225133143064747B5
DomainCount
Integer
查询域名中有效域名的数量。
20
StartTime
String
查询起始时间。
2021-01-01 00:00:00
EndTime
String
查询结束时间。
2021-01-01 23:59:59
Metrics
[ ]String
查询时选择展示的字段。
["bandwidth","2xx"]
Results
Result
查询数据明细。
-

调用示例

请求示例

POST https://open.volcengineapi.com/?Version=2021-04-01&Action=DescribeRealtimeData&<其他公共请求参数>
{
    "StartTime": "2023-10-26 13:55:00",
    "EndTime": "2023-10-26 14:00:00",
    "Domains":[ "chen***017.snssdk.com"],
    "Metrics": ["all"],
    "ProjectName": [],
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231026******9F8411CD98B4A074A0E",
        "Action": "DescribeRealtimeData",
        "Version": "2021-04-01",
        "Service": "dcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainCount": 1,
        "StartTime": "2023-10-26 13:55:00",
        "EndTime": "2023-10-26 14:00:00",
        "Metrics": [
            "all"
        ],
        "Results": [
            {
                "TimeStamp": "2023-10-26 13:55:00",
                "RealTimeResults": [
                    {
                        "DomainName": "chen***017.snssdk.com",
                        "DetailInfo": [
                            {
                                "Name": "2xx",
                                "Value": 0
                            },
                            {
                                "Name": "200",
                                "Value": 0
                            },
                            {
                                "Name": "201",
                                "Value": 0
                            },
                            {
                                "Name": "3xx",
                                "Value": 0
                            },
                            {
                                "Name": "301",
                                "Value": 0
                            },
                            {
                                "Name": "302",
                                "Value": 0
                            },
                            {
                                "Name": "4xx",
                                "Value": 0
                            },
                            {
                                "Name": "400",
                                "Value": 0
                            },
                            {
                                "Name": "403",
                                "Value": 0
                            },
                            {
                                "Name": "404",
                                "Value": 0
                            },
                            {
                                "Name": "499",
                                "Value": 0
                            },
                            {
                                "Name": "5xx",
                                "Value": 0
                            },
                            {
                                "Name": "500",
                                "Value": 0
                            },
                            {
                                "Name": "502",
                                "Value": 0
                            },
                            {
                                "Name": "504",
                                "Value": 0
                            },
                            {
                                "Name": "Traffic",
                                "Value": 0
                            },
                            {
                                "Name": "Request",
                                "Value": 0
                            },
                            {
                                "Name": "QPS",
                                "Value": 0
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "TrafficHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "RequestHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "ResponseTime",
                                "Value": 0
                            }
                        ]
                    }
                ]
            },
            {
                "TimeStamp": "2023-10-26 13:56:00",
                "RealTimeResults": [
                    {
                        "DomainName": "chen***017.snssdk.com",
                        "DetailInfo": [
                            {
                                "Name": "2xx",
                                "Value": 0
                            },
                            {
                                "Name": "200",
                                "Value": 0
                            },
                            {
                                "Name": "201",
                                "Value": 0
                            },
                            {
                                "Name": "3xx",
                                "Value": 0
                            },
                            {
                                "Name": "301",
                                "Value": 0
                            },
                            {
                                "Name": "302",
                                "Value": 0
                            },
                            {
                                "Name": "4xx",
                                "Value": 0
                            },
                            {
                                "Name": "400",
                                "Value": 0
                            },
                            {
                                "Name": "403",
                                "Value": 0
                            },
                            {
                                "Name": "404",
                                "Value": 0
                            },
                            {
                                "Name": "499",
                                "Value": 0
                            },
                            {
                                "Name": "5xx",
                                "Value": 0
                            },
                            {
                                "Name": "500",
                                "Value": 0
                            },
                            {
                                "Name": "502",
                                "Value": 0
                            },
                            {
                                "Name": "504",
                                "Value": 0
                            },
                            {
                                "Name": "Traffic",
                                "Value": 0
                            },
                            {
                                "Name": "Request",
                                "Value": 0
                            },
                            {
                                "Name": "QPS",
                                "Value": 0
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "TrafficHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "RequestHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "ResponseTime",
                                "Value": 0
                            }
                        ]
                    }
                ]
            },
            {
                "TimeStamp": "2023-10-26 13:57:00",
                "RealTimeResults": [
                    {
                        "DomainName": "chen***017.snssdk.com",
                        "DetailInfo": [
                            {
                                "Name": "2xx",
                                "Value": 0
                            },
                            {
                                "Name": "200",
                                "Value": 0
                            },
                            {
                                "Name": "201",
                                "Value": 0
                            },
                            {
                                "Name": "3xx",
                                "Value": 0
                            },
                            {
                                "Name": "301",
                                "Value": 0
                            },
                            {
                                "Name": "302",
                                "Value": 0
                            },
                            {
                                "Name": "4xx",
                                "Value": 0
                            },
                            {
                                "Name": "400",
                                "Value": 0
                            },
                            {
                                "Name": "403",
                                "Value": 0
                            },
                            {
                                "Name": "404",
                                "Value": 0
                            },
                            {
                                "Name": "499",
                                "Value": 0
                            },
                            {
                                "Name": "5xx",
                                "Value": 0
                            },
                            {
                                "Name": "500",
                                "Value": 0
                            },
                            {
                                "Name": "502",
                                "Value": 0
                            },
                            {
                                "Name": "504",
                                "Value": 0
                            },
                            {
                                "Name": "Traffic",
                                "Value": 0
                            },
                            {
                                "Name": "Request",
                                "Value": 0
                            },
                            {
                                "Name": "QPS",
                                "Value": 0
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "TrafficHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "RequestHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "ResponseTime",
                                "Value": 0
                            }
                        ]
                    }
                ]
            },
            {
                "TimeStamp": "2023-10-26 13:58:00",
                "RealTimeResults": [
                    {
                        "DomainName": "chen***017.snssdk.com",
                        "DetailInfo": [
                            {
                                "Name": "2xx",
                                "Value": 0
                            },
                            {
                                "Name": "200",
                                "Value": 0
                            },
                            {
                                "Name": "201",
                                "Value": 0
                            },
                            {
                                "Name": "3xx",
                                "Value": 0
                            },
                            {
                                "Name": "301",
                                "Value": 0
                            },
                            {
                                "Name": "302",
                                "Value": 0
                            },
                            {
                                "Name": "4xx",
                                "Value": 0
                            },
                            {
                                "Name": "400",
                                "Value": 0
                            },
                            {
                                "Name": "403",
                                "Value": 0
                            },
                            {
                                "Name": "404",
                                "Value": 0
                            },
                            {
                                "Name": "499",
                                "Value": 0
                            },
                            {
                                "Name": "5xx",
                                "Value": 0
                            },
                            {
                                "Name": "500",
                                "Value": 0
                            },
                            {
                                "Name": "502",
                                "Value": 0
                            },
                            {
                                "Name": "504",
                                "Value": 0
                            },
                            {
                                "Name": "Traffic",
                                "Value": 0
                            },
                            {
                                "Name": "Request",
                                "Value": 0
                            },
                            {
                                "Name": "QPS",
                                "Value": 0
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "TrafficHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "RequestHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "ResponseTime",
                                "Value": 0
                            }
                        ]
                    }
                ]
            },
            {
                "TimeStamp": "2023-10-26 13:59:00",
                "RealTimeResults": [
                    {
                        "DomainName": "chen***017.snssdk.com",
                        "DetailInfo": [
                            {
                                "Name": "2xx",
                                "Value": 0
                            },
                            {
                                "Name": "200",
                                "Value": 0
                            },
                            {
                                "Name": "201",
                                "Value": 0
                            },
                            {
                                "Name": "3xx",
                                "Value": 0
                            },
                            {
                                "Name": "301",
                                "Value": 0
                            },
                            {
                                "Name": "302",
                                "Value": 0
                            },
                            {
                                "Name": "4xx",
                                "Value": 0
                            },
                            {
                                "Name": "400",
                                "Value": 0
                            },
                            {
                                "Name": "403",
                                "Value": 0
                            },
                            {
                                "Name": "404",
                                "Value": 0
                            },
                            {
                                "Name": "499",
                                "Value": 0
                            },
                            {
                                "Name": "5xx",
                                "Value": 0
                            },
                            {
                                "Name": "500",
                                "Value": 0
                            },
                            {
                                "Name": "502",
                                "Value": 0
                            },
                            {
                                "Name": "504",
                                "Value": 0
                            },
                            {
                                "Name": "Traffic",
                                "Value": 0
                            },
                            {
                                "Name": "Request",
                                "Value": 0
                            },
                            {
                                "Name": "QPS",
                                "Value": 0
                            },
                            {
                                "Name": "Bandwidth",
                                "Value": 0
                            },
                            {
                                "Name": "TrafficHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "RequestHitRate",
                                "Value": 0
                            },
                            {
                                "Name": "ResponseTime",
                                "Value": 0
                            }
                        ]
                    }
                ]
            }
        ]
    }
}