DescribeCdnUserBillPrediction - CDN - Alibaba Cloud Documentation Center

Estimates resource usage of the current month.

Operation Description

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.

NoteFor more information about billable regions, see Billable regions.

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	READ	CDN acs:cdn::{#accountId}:	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	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. NoteFor more information about billable regions, see Billable regions.	2018-09-30T16:00:00Z
EndTime	string	No	The end time of the estimation.	2018-10-25T10:00:00Z
Dimension	string	No	The start time of the estimation.	flow
Area	string	No	The ID of the request.	CN,OverSeas

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The metering method. NoteIf 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	2018-10-25T10:00:00Z
StartTime	string	The estimated bill data.	2018-09-30T16:00:00Z
RequestId	string	The estimated value.	C370DAF1-C838-4288-A1A0-9A87633D248E
BillType	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.	month_95_overseas
BillPredictionData	object []	The billable region.

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_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.	-
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 StartTime is invalid.	The format of the start time is invalid. Specify a valid value.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The EndTime parameter is set in an invalid format. For more information, see the API references.
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 end time does not math the specified start time.	The end time cannot be earlier than the start time
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.