All Products
Search
Document Center

CDN:DescribeCdnUserBillHistory

Last Updated:Nov 29, 2024

Queries the billing history under your Alibaba Cloud account.

Operation description

  • You can query billing history up to the last one month.
  • You can call this operation up to 100 times 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeCdnUserBillHistorynone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The minimum data granularity is 5 minutes.

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

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The end time must be later than the start time.

2018-10-31T16:00:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

ED61C6C3-8241-4187-AAA7-5157AE175CEC
BillHistoryDataarray<object>

The billing history returned.

BillHistoryDataItemobject
Dimensionstring

The dimension.

flow
BillTypestring

The metering method.

month_4th_day_bandwidth
BillTimestring

The beginning of the time range that was queried.

2018-09-30T16:00:00Z
BillingDataarray<object>

The billable items.

BillingDataItemobject
Flowfloat

The amount of network traffic. Unit: bytes.

24567
Bandwidthfloat

The bandwidth. Unit: bit/s.

4041
Countfloat

The number of requests.

203601
CdnRegionstring

The billable region. Valid values:

  • CN: 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
AP1
ChargeTypestring

The billing method. Valid values:

  • StaticHttp: static HTTP requests
  • DynamicHttp: dynamic HTTP requests
  • DynamicHttps: dynamic HTTPS requests
DynamicHttp

Examples

Sample success responses

JSONformat

{
  "RequestId": "ED61C6C3-8241-4187-AAA7-5157AE175CEC",
  "BillHistoryData": {
    "BillHistoryDataItem": [
      {
        "Dimension": "flow",
        "BillType": "month_4th_day_bandwidth",
        "BillTime": "2018-09-30T16:00:00Z",
        "BillingData": {
          "BillingDataItem": [
            {
              "Flow": 24567,
              "Bandwidth": 4041,
              "Count": 203601,
              "CdnRegion": "AP1",
              "ChargeType": "DynamicHttp"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.-
400InvalidParameterProductInvalid Parameter Product.The Product parameter is set to an invalid value.
400InvalidParameterAliuidInvalid Parameter Aliuid.The Aliuid parameter is set to an invalid value.
400InvalidParameterStartTimeThe parameter StartTime is invalid.The specified StartTime parameter is invalid.
400InvalidParameterEndTimeThe parameter EndTime is invalid.-
400InvalidTimeRangeInvalid StartTime and EndTime range.The specified time range is invalid.

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

Change history

Change timeSummary of changesOperation
2023-07-05The Error code has changedView Change Details