调用DescribeCdnUserBillPrediction预测用户当月的用量数据。
接口说明
用于预测用户当月的用量数据,按用户月初第一天的计费模式计算,只支持月度计费模式的预测,只支持用户粒度。 起始时间为月初 1 号 0 点,结束时间为当前时间前两个小时。
- 月 95:开始时间至结束时间内,去掉最高 5%点后的最高点,为预测值。
- 月均日峰值:每日峰值带宽求和/时间天数,不计算当天的数据。
- 月第四日峰值:请求时间内,第四高的峰值为预测值,如果请求时间小于 4 天,返回预测值为 0。
- 月均日 95:每日日 95 峰值求和/时间天数,不计算当天的数据。
- 夜间半价 95:开始时间至结束时间内,去掉最高 5%点后的最高点,为预测值。
说明
单用户调用频率:1 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cdn:DescribeCdnUserBillPrediction | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StartTime | string | 否 | 默认为月初第一天的零点整, 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 | 2018-09-30T16:00:00Z |
EndTime | string | 否 | 默认为当前时间, 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。
| 2018-10-25T10:00:00Z |
Dimension | string | 否 | 获取计费类型的维度,flow 表示流量带宽。 | flow |
Area | string | 否 | 计费大区。取值:
默认按用户当前计费模式决定,如果是海外分大区则为 CN,OverSeas,否则为 CN,AP1,AP2,AP3,NA,SA,EU 或 MEAA。 说明
各区域包含的具体国家地区,请参见计费概述。
| CN,OverSeas |
返回参数
示例
正常返回示例
JSON
格式
{
"EndTime": "2018-10-25T10:00:00Z",
"StartTime": "2018-09-30T16:00:00Z",
"RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
"BillType": "month_95_overseas",
"BillPredictionData": {
"BillPredictionDataItem": [
{
"Value": 10000,
"TimeStp": "2018-10-15T16:00:00Z",
"Area": "CN"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 参数错误 |
400 | BillTypeNotFound | The user billing type is not found or the billing type of this user is not the monthly billing type. | 用户账单类型不存在或不是月账单类型用户 |
400 | InvalidStartTime.Malformed | The specified value of parameter StartTime is malformed. | 开始时间格式错误。日期格式请参考所调用API的帮助文档说明。 |
400 | InvalidEndTime.Malformed | The specified value of parameter EndTime is malformed. | 参数EndTime格式错误。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 开始时间设置错误,请检查更新后重试。 |
400 | InvalidTime.Malformed | Specified Time is malformed. | 指定时间格式错误。 |
400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | 指定的EndTime与StartTime不匹配,StartTime应早于EndTime。 |
400 | InvalidTimeSpan | The time span exceeds the limit. | 时间跨度超过限制,请参照接口文档,配置合理查询跨度。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |