获取域名带宽数据按ip协议【新】 - GetUcdnDomainBandwidthByIpProtocol
简介
获取域名带宽数据按ip协议(新)
定义
公共参数
参数名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
Action | string | 对应的 API 指令名称,当前 API 为 GetUcdnDomainBandwidthByIpProtocol | Yes |
PublicKey | string | 用户公钥,可从 控制台 获取 | Yes |
Signature | string | 根据公钥及 API 指令生成的用户签名,参见 签名算法 | Yes |
请求参数
参数名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
ProjectId | string | 项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 | No |
Type | int | 时间粒度(0表示按照5分钟粒度,1表示按照1小时粒度,2表示按照一天的粒度,3表示按照1分钟粒度) | Yes |
IpProtocol | string | 协议,ipv4、ipv6 | Yes |
DomainId.N | string | 域名id,创建域名时生成的id。默认全部域名 | No |
Areacode | string | 查询带宽区域 cn代表国内 abroad代表海外 不填默认为全部区域 | No |
BeginTime | int | 查询的起始时间,格式为Unix Timestamp。如果有EndTime,BeginTime必须赋值。如没有赋值,则返回缺少参 数错误,如果没有EndTime,BeginTime也可以不赋值,EndTime默认当前时间,BeginTime 默认前一天的当前时间。 | No |
EndTime | int | 查询的结束时间,格式为Unix Timestamp。EndTime默认为当前时间,BeginTime默认为当前时间前一天时间。 | No |
响应字段
字段名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
RetCode | int | 返回状态码,为 0 则为成功返回,非 0 为失败 | Yes |
Action | string | 操作指令名称 | Yes |
Message | string | 返回错误消息,当 RetCode 非 0 时提供详细的描述信息 | No |
BandwidthTrafficList | array[BandwidthTrafficInfo] | 带宽信息列表,参见BandwidthTrafficInfo | No |
数据模型
BandwidthTrafficInfo
字段名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
Time | int | 带宽获取的时间点。格式:时间戳 | Yes |
CdnBandwidth | float | 返回值返回指定时间区间内CDN的带宽峰值,单位Mbps(如果请求参数Type为0,则Value是五分钟粒度的带宽值,如果Type为1,则Value是1小时的带宽峰值,如果Type为2,则Value是一天内的带宽峰值) | Yes |
Traffic | float | 对应时间粒度的流量,单位字节 | Yes |
示例
请求示例
https://api.an-link.com/?Action=GetUcdnDomainBandwidthByIpProtocol
&ProjectId=mwJINqhT
&Type=8
&DomainId.n=evUeDPDj
&Areacode=ZYoVRdyx
&BeginTime=4
&EndTime=5
&Protocol=KoHunSKK
响应示例
{
"Action": "GetUcdnDomainBandwidthByIpProtocolResponse",
"BandwidthTrafficList": [
{
"CdnBandwidth": 4.33645,
"Time": 7,
"Traffic": 6.58469
}
],
"RetCode": 0
}