Query 95th Percentile Traffic via OpenAPI - Internet Shared Bandwidth - Alibaba Cloud - Internet Shared Bandwidth

Call the Describe95Traffic operation to query 95th percentile traffic data for Internet Shared Bandwidth billed based on the enhanced 95th percentile method.

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

vpc:Describe95Traffic

get

*BandwidthPackage

acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
ResourceType	string	Yes	The resource type. Only cbwp is supported, which represents Internet Shared Bandwidth.	cbwp
InstanceId	string	Yes	The resource ID.	cbwp-wz9j19xrwf78fvz7*****
Day	string	Yes	The date to query, in UTC+8. Format: YYYY-MM-DD. Note You can query only data from last month or earlier.	2022-10-22

Response elements

Element	Type	Description	Example
	object	The list of returned information.
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
Traffic95Summary	object	The bandwidth statistics for Internet Shared Bandwidth billed by enhanced 95th percentile.
InternetChargeType	string	The billing method of the Internet Shared Bandwidth instance on the queried date. Valid values: PayBy95: pay-by-enhanced-95th-percentile PayByBandwidth: pay-by-bandwidth PayByDominantTraffic: pay-by-dominant-traffic	PayBy95
InstanceId	string	The resource ID.	cbwp-wz9j19xrwf78fvz7*****
Bandwidth	integer	The peak bandwidth of the Internet Shared Bandwidth instance on the queried date. Unit: Mbps.	20000.0
FifthPeakBandwidth	string	The daily peak bandwidth. Unit: Mbps.	1064.244837773641
MinimumConsumeBandwidth	string	The minimum bandwidth commitment of the Internet Shared Bandwidth instance on the queried date. Unit: Mbps.	0.0
Traffic95DetailList	object
Traffic95Detail	array<object>	The list of average bandwidth values per 5 minutes for inbound and outbound directions on the queried date.
	object	The average bandwidth per 5-minute interval for inbound and outbound directions on the queried date, sampled at 5-minute granularity.
Time	string	The timestamp (as a string).	2024-01-01T00:00:00Z
BillBandwidth	string	The bandwidth value at the sampling point. This is the higher of the inbound or outbound bandwidth during the time interval. Unit: Mbps.	118.5090322113037
OutBandwidth	string	The outbound bandwidth. Unit: Mbps.	96.41217480977376
InBandwidth	string	The inbound bandwidth. Unit: Mbps.	118.5090322113037

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "Traffic95Summary": {
    "InternetChargeType": "PayBy95",
    "InstanceId": "cbwp-wz9j19xrwf78fvz7*****\n",
    "Bandwidth": 20000,
    "FifthPeakBandwidth": "1064.244837773641",
    "MinimumConsumeBandwidth": "0.0",
    "Traffic95DetailList": {
      "Traffic95Detail": [
        {
          "Time": "2024-01-01T00:00:00Z",
          "BillBandwidth": "118.5090322113037",
          "OutBandwidth": "96.41217480977376",
          "InBandwidth": "118.5090322113037"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstance.NotFound	The specified Instance does not exist in the specified region.
400	IllegalParam.Day	The specified parameter day is illegal.	The specified input parameter Day is invalid.
400	IllegalParam.ResourceType	Invalid Resource Type value.	The ResourceType parameter is not supported or set to an invalid value.
400	OperationDenied.QueryCdt95Instance	The operation is not allowed because of QueryCdt95Instance.	The error message returned because you cannot query an EIP bandwidth plan connected to CDT.
400	OperationUnsupported.QueryCurrentMonthTraffic	The operation is not allowed because current month traffic query is not supported under 95 billing mode.	Querying the current month traffic data in the 95 billing mode is not supported.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.