DescribeLiveUserBillPrediction - 获取直播用户预期账单

获取直播用户预期账单

接口说明

用于预测用户当月的用量数据,按用户月初第一天的计费模式计算,只支持月度计费模式的预测,只支持用户粒度。 起始时间为月初 1 号 0 点,结束时间为当前时间前两个小时。

  • 月 95:开始时间至结束时间内,去掉最高 5%点后的最高点,为预测值。

  • 月均日峰值:每日峰值带宽求和/时间天数,不计算当天的数据。

  • 月第四峰:请求时间内,第四高的峰值为预测值,如果请求时间小于 4 天,返回预测值为 0。

  • 日 95 月平均:每日日 95 峰值求和/时间天数,不计算当天的数据。

  • 夜间 95:开始时间至结束时间内,去掉最高 5%点后的最高点,为预测值。

QPS 限制

本接口的单用户 QPS 限制为 1 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeLiveUserBillPrediction

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

StartTime

string

开始时间。格式为:yyyy-mm-ddthh:mm:ssz(utc 时间)。

2015-12-01T05:40:00Z

EndTime

string

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2015-12-01T05:45:00Z

返回参数

名称

类型

描述

示例值

object

EndTime

string

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

2018-10-25T10:00:00Z

StartTime

string

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

2018-09-30T16:00:00Z

RequestId

string

请求 ID。

B95BE680-5A6A-1CAD-8AB1-09DFF5D6****

BillType

string

用户计费类型。计费模式取值如下所示:

  • 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:按日请求次数计费。

day_bandwidth

BillPredictionData

object

BillPredictionDataItem

array<object>

账单预测数据。

object

账单预测数据。

Value

number

预测值。

10000

TimeStp

string

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

2018-10-15T16:00:00Z

Area

string

区域代号。支持:

  • CN:中国内地。

  • OverSeas:海外大区。

  • AP1:亚太 1 区,包含中国香港地区、中国澳门地区、中国台湾地区、日本以及东南亚除越南和印尼之外的国家。

  • AP2:亚太 2 区,包含印尼、韩国、越南。

  • AP3:亚太 3 区,包含澳大利亚、新西兰。

  • NA:北美,包含美国、加拿大。

  • SA:南美,特指巴西。

  • EU:欧洲,包含乌克兰、英国、法国、荷兰、西班牙、意大利、瑞典、德国。

  • MEAA:中东非洲,包含南非、阿曼、阿联酋、科威特。

不传值时默认为所有区域数据聚合输出。

CN

示例

正常返回示例

JSON格式

{
  "EndTime": "2018-10-25T10:00:00Z",
  "StartTime": "2018-09-30T16:00:00Z",
  "RequestId": "B95BE680-5A6A-1CAD-8AB1-09DFF5D6****",
  "BillType": "day_bandwidth",
  "BillPredictionData": {
    "BillPredictionDataItem": [
      {
        "Value": 10000,
        "TimeStp": "2018-10-15T16:00:00Z",
        "Area": "CN"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter InvalidParameter.
400 InvalidStartTime.Malformed The specified StartTime parameter is invalid.
400 InvalidEndTime.Malformed The specified EndTime is invalid.
400 InvalidStartTime.ValueNotSupported The StartTime cannot exceed 31 days before the current time.
400 InvalidTime.Malformed Specified Time is malformed. 制定时间错误,请您确认该制定时间是否正确。
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 结束时间与开始时间不匹配,请您确认时间的匹配度。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400 BillTypeNotFound User bill type not found or is not monthly bill type. 账单类型不存在或不是月账单类型用户

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

变更历史

更多信息,参考变更详情