文档

DescribeCdnUserBillPrediction - 查询预测用量

更新时间:

调用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:DescribeCdnUserBillPredictionWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
StartTimestring

默认为月初第一天的零点整, 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

2018-09-30T16:00:00Z
EndTimestring

默认为当前时间, 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。

说明 结束时间需大于起始时间。
2018-10-25T10:00:00Z
Dimensionstring

获取计费类型的维度,flow 表示流量带宽。

flow
Areastring

计费大区。取值:

  • CN:中国内地。
  • OverSeas:全球(不包含中国内地)。
  • AP1:亚太 1 区。
  • AP2:亚太 2 区。
  • AP3:亚太 3 区。
  • NA:北美。
  • SA:南美。
  • EU:欧洲。
  • MEAA:中东、非洲。

默认按用户当前计费模式决定,如果是海外分大区则为 CNOverSeas,否则为 CNAP1AP2AP3NASAEUMEAA

说明 各区域包含的具体国家地区,请参见计费概述
CN,OverSeas

返回参数

名称类型描述示例值
object
EndTimestring

预测结束时间。

2018-10-25T10:00:00Z
StartTimestring

预测开始时间。

2018-09-30T16:00:00Z
RequestIdstring

请求 ID。

C370DAF1-C838-4288-A1A0-9A87633D248E
BillTypestring

用户计费类型。

说明 _overseas后缀表示海外不分大区计费,例如: "BillType": "month_avg_day_bandwidth_overseas" 则表明该计费方式为月均日峰值海外不分区计费。

计费模式取值如下所示:

  • hour_flow:按小时流量计费。
  • day_bandwidth:按日带宽计费。
  • month_95:按月 95 峰值带宽计费。
  • month_avg_day_bandwidth:按月均日峰值带宽计费。
  • month_4th_day_bandwidth:按月第四日峰值带宽计费。
  • month_avg_day_95:按月均日 95 峰值带宽计费。
  • month_95_night_half: 按夜间半价 95 峰值带宽计费。
  • hour_vas:按小时增值服务计费。
  • day_count:按日请求次数计费。
month_95_overseas
BillPredictionDataobject []

账单预测数据。

Valuefloat

预测值。

10000
TimeStpstring

预测值对应的时刻,仅 95、夜间半价 95 和月第四日峰值有这个字段。

2018-10-15T16:00:00Z
Areastring

计费大区。

CN

示例

正常返回示例

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错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.参数错误
400BillTypeNotFoundThe user billing type is not found or the billing type of this user is not the monthly billing type.用户账单类型不存在或不是月账单类型用户
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.开始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.参数EndTime格式错误。
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.开始时间设置错误,请检查更新后重试。
400InvalidTime.MalformedSpecified Time is malformed.指定时间格式错误。
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.指定的EndTime与StartTime不匹配,StartTime应早于EndTime。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)