调用DescribeVodDomainTrafficData获取加速域名的网络流量监控数据。
接口说明
- 目前服务地址仅支持:华东 2(上海)。
- 支持批量查询。
- 不指定 StartTime 和 EndTime 时,默认读取过去 24 小时的数据。也可以按指定的起止时间查询,必须同时指定 StartTime 和 EndTime,最多可获取近 90 天的数据。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vod:DescribeVodDomainTrafficData | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 否 | 要查询的域名。若为空,则默认返回所有加速域名的合并数据。支持批量查询,多个域名之间用半角逗号(,)分隔。 | example.com |
StartTime | string | 否 | 获取数据起始时间点。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
最小数据粒度为 5 分钟。若为空,则默认读取最近 24 小时的数据。
| 2019-01-20T13:59:58Z |
EndTime | string | 否 | 结束时间,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2019-01-20T14:59:58Z |
Interval | string | 否 | 查询数据的时间粒度。单位:秒。支持 300、3600 和 86400。不传和传的值不支持时,使用默认值。
| 300 |
IspNameEn | string | 否 | 运营商英文名。不传入该参数,默认查询所有运营商。 | Alibaba |
LocationNameEn | string | 否 | 地域英文名。不传入该参数,默认查询所有地域。目前仅支持上海地域。 | cn-shanghai |
返回参数
示例
正常返回示例
JSON
格式
{
"EndTime": "2019-01-20T14:59:58Z",
"StartTime": "2019-01-20T13:59:58Z",
"RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
"DomainName": "example.com",
"TotalTraffic": "5906662826",
"DataInterval": "3600",
"TrafficDataPerInterval": {
"DataModule": [
{
"HttpsDomesticValue": "0",
"Value": "0",
"OverseasValue": "0",
"HttpsValue": "0",
"HttpsOverseasValue": "0",
"TimeStamp": "2019-01-15T19:00:00Z",
"DomesticValue": "0"
}
]
}
}
错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
错误代码 | 错误信息 | HTTP 状态码 | 说明 |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | 请求被流量控制限制。 |
IllegalOperation | Illegal domain, operation is not permitted. | 403 | 非法域名, 无法操作。 |
OperationDenied | Your account does not open CDN service yet. | 403 | 未开通 CDN 服务。 |
OperationDenied | Your CDN service is suspended. | 403 | CDN 服务已被停止。 |
InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。 |
InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下线。 |
ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中, 请稍后再试。 |
InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失败。 |
MissingParameter | StartTime and EndTime can not be single. | 400 | StartTime 和 EndTime 不能单独设置。 |
InvalidStartTime.Malformed | Specified start time is malformed. | 400 | StartTime 格式错误。 |
InvalidEndTime.Malformed | Specified end time is malformed. | 400 | EndTime 格式错误。 |
InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | 400 | EndTime 小于 StartTime。 |
InvalidStartTime.ValueNotSupported | Specified end time does not match the specified start time. | 400 | EndTime 和 StartTime 差值超过 90 天。 |