DocsICP FilingConsole
Documentation

DescribeCdnUserBillPrediction

Updated at:
Copy as MD
Product
My Favorites

Predicts the usage data of the current month.

Operation description

Predicts the usage data of the current month. The prediction is calculated based on the billing method on the first day of the month. Only monthly billing methods and user-level predictions are supported. The start time is 00:00:00 on the first day of the month, and the end time is two hours before the current time.

  • Monthly 95th percentile: the highest point after removing the top 5% of data points between the start time and the end time.

  • Monthly average daily peak bandwidth: the sum of daily peak bandwidths divided by the number of days. Data of the current day is not included.

  • Monthly fourth-day peak bandwidth: the fourth highest peak bandwidth within the requested time range. If the requested time range is less than 4 days, the predicted value is 0.

  • Monthly average daily 95th percentile: the sum of daily 95th percentile peak bandwidths divided by the number of days. Data of the current day is not included.

  • Nighttime half-price 95th percentile: the highest point after removing the top 5% of data points between the start time and the end time.

Note

Rate limit per user: 1 call per second.

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

cdn:DescribeCdnUserBillPrediction

none

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
StartTime

string

No

The start time. Default value: 00:00:00 on the first day of the month. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

string

No

The end time. Default value: the current time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note

The end time must be later than the start time.

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

string

No

The dimension for the billing type. A value of flow indicates data transfer and bandwidth.

flow
Area

string

No

The billing region. Valid values:

  • CN: the Chinese mainland.

  • OverSeas: global (excluding the Chinese mainland).

  • AP1: Asia Pacific 1.

  • AP2: Asia Pacific 2.

  • AP3: Asia Pacific 3.

  • NA: North America.

  • SA: South America.

  • EU: Europe.

  • MEAA: Middle East and Africa.

The default value is determined by the current billing method of the user. If the billing method is divided into regions outside the Chinese mainland, the default value is CN and OverSeas. Otherwise, the default value is CN, AP1, AP2, AP3, NA, SA, EU, or MEAA.

Note

For more information about the countries and regions included in each area, see Billing overview.

CN,OverSeas

Response elements

Element

Type

Description

Example

object

EndTime

string

The end time of the prediction. The time is in the ISO 8601 format and in UTC.

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

string

The start time of the prediction. The time is in the ISO 8601 format and in UTC.

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

string

The request ID.

C370DAF1-C838-4288-A1A0-9A87633D248E
BillType

string

The billing type of the user.

Note

A value with the _overseas suffix indicates that the metering method is not divided into regions outside the Chinese mainland. For example, if the value is "BillType": "month_avg_day_bandwidth_overseas", it indicates that the metering method is monthly average daily peak bandwidth without region division outside the Chinese mainland.

Valid values:

  • hour_flow: billed by hourly data transfer.

  • day_bandwidth: billed by daily bandwidth.

  • month_95: billed by monthly 95th percentile bandwidth.

  • month_avg_day_bandwidth: billed by monthly average daily peak bandwidth.

  • month_4th_day_bandwidth: billed by monthly fourth-day peak bandwidth.

  • month_avg_day_95: billed by monthly average daily 95th percentile bandwidth.

  • month_95_night_half: billed by nighttime half-price 95th percentile bandwidth.

  • hour_vas: billed by hourly value-added services.

  • day_count: billed by daily requests.

month_95_overseas
BillPredictionData

object

BillPredictionDataItem

array<object>

The billing prediction data.

object

Value

number

The predicted value.

10000
TimeStp

string

The time corresponding to the predicted value. This field is available only for the 95th percentile, nighttime half-price 95th percentile, and monthly fourth-day peak bandwidth.

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

string

The billing region.

CN

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidParameter The specified parameter is invalid. An exception occurred while deleting the live streaming region.
400 BillTypeNotFound The user billing type is not found or the billing type of this user is not the monthly billing type. The bill type does not exist, or your account does not support monthly bills.
400 InvalidStartTime.Malformed The specified value of parameter StartTime is malformed.
400 InvalidEndTime.Malformed The specified value of parameter EndTime is malformed.
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. StartTime must be earlier than EndTime.
400 InvalidTimeSpan The time span exceeds the limit. The time span exceeds the limit. Configure a valid time span as described in API documentation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.