DescribeLiveUserBillPrediction - - Alibaba Cloud Documentation Center

Retrieves the bill prediction for a live streaming user.

Operation description

This operation predicts your usage data for the current month. The prediction is based on the billing method that is active on the first day of the month. This operation supports predictions for monthly billing methods only and provides data at the user level. The query time range starts at 00:00 on the first day of the month and ends two hours before the current time.

Monthly 95th percentile: The highest data point after the top 5% of data points are removed from the specified time range.
Monthly average of daily peak bandwidth: The sum of daily peak bandwidth values divided by the number of days in the time range. The current day's data is not included.
Monthly 4th peak: The fourth-highest peak bandwidth in the specified time range. If the time range is less than four days, the predicted value is 0.
Monthly average of daily 95th percentile peak: The sum of daily 95th percentile peak values divided by the number of days in the time range. The current day's data is not included.
Nightly 95th percentile: The highest data point after the top 5% of data points are removed from the specified time range.

QPS limit

The queries per second (QPS) limit for a single user is 1. If you exceed this limit, your API calls are throttled, which may affect your business. Make API calls at a reasonable rate. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveUserBillPrediction

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StartTime	string	No	The start time. The time must be in UTC and follow the yyyy-mm-ddThh:mm:ssZ format.	2015-12-01T05:40:00Z
EndTime	string	No	The end time. The time must be in UTC and follow the yyyy-MM-ddTHH:mm:ssZ format.	2015-12-01T05:45:00Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time of the query. The time is in UTC and follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ. The default value is the current time.	2018-10-25T10:00:00Z
StartTime	string	The start time of the query. The time is in UTC and follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ. The default value is 00:00 on the first day of the month.	2018-09-30T16:00:00Z
RequestId	string	The request ID.	B95BE680-5A6A-1CAD-8AB1-09DFF5D6****
BillType	string	The billing method. The following billing methods are supported: hour_flow: Pay-by-traffic on an hourly basis. day_bandwidth: Pay-by-bandwidth on a daily basis. month_95: Pay-by-monthly 95th percentile peak bandwidth. month_avg_day_bandwidth: Pay-by-monthly average of daily peak bandwidth. month_4th_day_bandwidth: Pay-by-monthly 4th peak bandwidth. month_avg_day_95: Pay-by-monthly average of daily 95th percentile peak bandwidth. month_95_night_half: Pay-by-nightly 95th percentile peak bandwidth with a 50% discount. hour_vas: Pay-for-value-added services on an hourly basis. day_count: Pay-by-daily request count.	day_bandwidth
BillPredictionData	object
BillPredictionDataItem	array<object>	The bill prediction data.
	object	The bill prediction data.
Value	number	The predicted value.	10000
TimeStp	string	The timestamp of the predicted value. This parameter is returned only for the month_95, month_95_night_half, and month_4th_day_bandwidth billing methods.	2018-10-15T16:00:00Z
Area	string	The region code. Valid values: CN: the Chinese mainland. OverSeas: regions outside China. AP1: Asia Pacific 1. This region includes Hong Kong (China), Macao (China), Taiwan (China), Japan, and Southeast Asian countries except for Vietnam and Indonesia. AP2: Asia Pacific 2. This region includes Indonesia, South Korea, and Vietnam. AP3: Asia Pacific 3. This region includes Australia and New Zealand. NA: North America. This region includes the United States and Canada. SA: South America. This region includes Brazil. EU: Europe. This region includes Ukraine, the United Kingdom, France, the Netherlands, Spain, Italy, Sweden, and Germany. MEAA: Middle East and Africa. This region includes South Africa, Oman, the United Arab Emirates, and Kuwait. If you do not specify this parameter, data from all regions is aggregated and returned.	CN

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.	Invalid time. Check whether the time that you specified is correct.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.
400	BillTypeNotFound	User bill type not found or is not monthly bill type.	The bill type does not exist, or your account does not support monthly bills.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.