文档中心 API文档 查询各ISP各省份维度的在线人数

查询各ISP各省份维度的在线人数

更新时间:2023-05-26 13:58:50

适用产品

直播分发

接口描述

查询各ISP各省份维度的在线人数

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称类型必填描述
dateFrom
String开始时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于当前时间-183天,并且小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过1小时(可联系技术支持调整); 4.dateFrom和dateTo要么都传递,要么都不传递; 5.dateFrom和dateTo都未传递,则默认查询过去30分钟的数据;
dateTo
String结束时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom;如果大于当前时间,则重新赋值为当前时间;
domain
List域名: 可传递域名数量上限默认为20个(可联系技术支持调整); 自动过滤掉非法域名(如传递非法域名,会被过滤掉,查询结果只返回合法域名的数据) 域名超过上限,报错
dataInterval
String数据粒度: 1m: 1分钟粒度 5m: 5分钟粒度 不传默认查询 5m
province
List默认查询全部省份,传递省份中文名称,省份信息码表详见概览页附录说明章节
isp
List默认查询全部运营商,传递运营商中文名称,运营商信息码表详见概览页附录说明章节
groupBy
List分组维度: 可选值为domain,province,isp,可传入多个值; 有传入则按照该维度展示明细数据;

返回参数

Body 参数

参数名称类型描述
code
String请求结果状态码
message
String请求结果信息
data
List
domain
String域名
ispData
List
isp
String运营商
provinceData
List
province
String省份
details
List
timestamp
String时间,格式为yyyy-MM-dd HH:mm
value
String在线人数

错误码

错误代码(code)描述(message)HTTP状态码语义
24102014This operation requires a body. Ensure that the body is present and the Content-Type header is set.400请求体没有传递
24102013The accept header specified in your request is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
24102020The value of X-Time-Zone header specified in your request in invalid.400请求头时区不合法
24102002There was an error in the body of your HTTP request.400请求体格式错误
24102006The date specified is invalid.400dateFrom或dateTo不符合规范或时间区间不合法
24102007You cannot specify a period greater than xx minutes.400dateFrom和dateTo相差超过限制值
24102019The request was rejected because the number of domain(xx) exceeds the limit (xx).400传递的域名个数超过账号限制
24102008param: domain is null or invalid.400参数domain不符合规范
24102008param: province is null or invalid.400参数province不符合规范
24102008param: isp is null or invalid.400参数isp不符合规范
24102008param: groupBy is null or invalid.400参数groupBy不符合规范
24102500We encountered an internal error. Please try again.500系统发生错误

示例

JSON
JSON
请求示例
复制代码 复制成功
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/api/report/online-num/isp-province/detail" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{
    "dateFrom": "2021-06-01T18:00:00+08:00",
    "dateTo": "2021-06-01T19:00:00+08:00",
    "domain": [
        "lvs.abc.com",
        "vodtest.abc.com"
    ],
    "dataInterval": "5m",
    "province": [
        "福建",
        "江苏",
        "陕西"
    ],
    "isp": [
        "中国电信",
        "中国联通",
        "中国移动",
        "长城宽带"
    ],
    "groupBy": [
        "province",
        "isp",
        "domain"
    ]
}'
返回示例
复制代码 复制成功
{
    "code": "0",
    "message": "success",
    "data": [
        {
            "domain": "vodtest.abc.com",
            "ispData": [
                {
                    "isp": "中国移动",
                    "provinceData": [
                        {
                            "province": "福建",
                            "details": [
                                {
                                    "timestamp": "2021-06-01 18:00",
                                    "value": "6600"
                                },
                                {
                                    "timestamp": "2021-06-01 18:05",
                                    "value": "26400"
                                }
                            ]
                        }
                    ]
                },
                {
                    "isp": "中国电信",
                    "provinceData": [
                        {
                            "province": "福建",
                            "details": [
                                {
                                    "timestamp": "2021-06-01 18:00",
                                    "value": "16600"
                                },
                                {
                                    "timestamp": "2021-06-01 18:05",
                                    "value": "166400"
                                }
                            ]
                        },
                        {
                            "province": "江苏",
                            "details": [
                                {
                                    "timestamp": "2021-06-01 18:00",
                                    "value": "26600"
                                },
                                {
                                    "timestamp": "2021-06-01 18:05",
                                    "value": "206400"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "domain": "lvs.abc.com",
            "ispData": [
                {
                    "isp": "中国移动",
                    "provinceData": [
                        {
                            "province": "福建",
                            "details": [
                                {
                                    "timestamp": "2021-06-01 18:00",
                                    "value": "6600"
                                },
                                {
                                    "timestamp": "2021-06-01 18:05",
                                    "value": "26400"
                                }
                            ]
                        }
                    ]
                },
                {
                    "isp": "中国电信",
                    "provinceData": [
                        {
                            "province": "福建",
                            "details": [
                                {
                                    "timestamp": "2021-06-01 18:00",
                                    "value": "16600"
                                },
                                {
                                    "timestamp": "2021-06-01 18:05",
                                    "value": "166400"
                                }
                            ]
                        },
                        {
                            "province": "江苏",
                            "details": [
                                {
                                    "timestamp": "2021-06-01 18:00",
                                    "value": "26600"
                                },
                                {
                                    "timestamp": "2021-06-01 18:05",
                                    "value": "206400"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!