DescribeCdnUserBillPrediction - CDN - Alibaba Cloud Documentation Center

Estimates resource usage of the current month.

Operation description

You can call this operation to estimate resource usage of the current month based on the metering method that is specified on the first day of the current month. You can call this operation to estimate resource usage only of the current month within your Alibaba Cloud account. The time range used for the estimation starts at 00:00 on the first day of the current month and ends 2 hours earlier than the current time.

Pay by monthly 95th percentile: The top 5% values between the start time and end time are excluded. The estimated value is the highest value among the remaining values.
Pay by average daily peak bandwidth per month: Estimated value = Sum of daily peak bandwidth values/Number of days. The current day is excluded.
Pay by 4th peak bandwidth per month: The estimated value is the 4th peak bandwidth value between the start time and end time. If the time range is less than four days, the estimated value is 0.
Pay by average daily 95th percentile bandwidth per month: Estimated value = Sum of daily 95th percentile bandwidth values/Number of days. The current day is excluded.
Pay by 95th percentile bandwidth with 50% off from 00:00 to 08:00: The top 5% values between the start time and end time are excluded. The estimated value is the highest value among the remaining values.

Note You can call this operation only once per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cdn:DescribeCdnUserBillPrediction	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start time of the estimation. The default value is 00:00 on the first day of the current 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 of the estimation. The default value is 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 billable item. A value of flow specifies bandwidth.	flow
Area	string	No	The billable region. Valid values: CN: the Chinese mainland OverSeas: outside 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 By default, the value of this parameter is determined by the metering method that is currently used. Regions inside and outside the Chinese mainland are classified into the CN and OverSeas billable regions. Billable regions inside the Chinese mainland include CN. Billable regions outside the Chinese mainland include AP1, AP2, AP3, NA, SA, EU, and MEAA. Note For more information about billable regions, see Billable regions.	CN,OverSeas

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end time of the estimation.	2018-10-25T10:00:00Z
StartTime	string	The start time of the estimation.	2018-09-30T16:00:00Z
RequestId	string	The ID of the request.	C370DAF1-C838-4288-A1A0-9A87633D248E
BillType	string	The metering method. Note If the metering method ends with _overseas, the billable region is outside the Chinese mainland. For example, BillType": "month_avg_day_bandwidth_overseas specifies a billable region outside the Chinese mainland and that the metering method is pay by daily peak bandwidth per month. Valid values: hour_flow: pay by hourly data transfer day_bandwidth: pay by daily bandwidth month_95: pay by monthly 95th percentile bandwidth. month_avg_day_bandwidth: pay by average daily peak bandwidth per month month_4th_day_bandwidth: pay by monthly 4th peak bandwidth month_avg_day_95: pay by average daily 95th percentile bandwidth per month month_95_night_half: pay by 95th percentile bandwidth with 50% off from 00:00 to 08:00. hour_vas: pay by value-added services per hour day_count: pay by daily requests	month_95
BillPredictionData	array<object>	The estimated bill data.
BillPredictionDataItem	object
Value	float	The estimated value.	10000
TimeStp	string	The time when the value used as the estimated value is generated. This parameter is returned only if the metering method is pay by 95th percentile, pay by 95th percentile bandwidth with 50% off from 00:00 to 08:00, or pay by 4th peak bandwidth per month.	2018-10-15T16:00:00Z
Area	string	The billable region.	CN

Examples

Sample success responses

JSONformat

{
  "EndTime": "2018-10-25T10:00:00Z",
  "StartTime": "2018-09-30T16:00:00Z",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D248E",
  "BillType": "month_95",
  "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.	-
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.	The specified start time is invalid. For more information, see the help documentation of this operation.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.	The specified EndTime parameter is invalid.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The start time is invalid. Set this parameter to another value and try again.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-13	The Error code has changed	View Change Details