Use DescribeUserBandWidthData to query user bandwidth data - ENS

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

ens:DescribeUserBandWidthData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the node. You can specify only one node ID. By default, all nodes are queried.	cn-taiyuan-telecom
InstanceId	string	No	The ID of the instance for which you want to query the data. You can specify only one instance ID. By default, all instances are queried.	i-5inkeimcipxk26yqtzm4q****
StartTime	string	Yes	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. If the value of the seconds place is not 00, the start time is automatically set to the next minute.	2019-05-21T10:22:00Z
EndTime	string	Yes	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. If the value of the seconds place is not 00, the start time is automatically set to the next minute.	2019-05-21T12:22:00Z
Period	string	Yes	The precision of the monitoring data that you want to obtain. Valid values: 300, 1200, 3600, and 14400. Default value: 300. Unit: seconds.	300
Isp	string	No	The Internet service provider (ISP). Valid values: cmcc: China Mobile telecom: China Telecom unicom: China Unicom multiCarrier: multi-line ISP	cmcc

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned service code. 0 indicates that the request was successful.	0
MonitorData	object	The monitoring data.
BandWidthMonitorData	array<object>	The bandwidth data.
	object
DownBandWidth	integer	The outbound bandwidth. Unit: bit/s.	0
InternetRX	integer	The Internet traffic to the instance. Unit: bytes.	0
InternetTX	integer	The Internet traffic from the instance. Unit: bytes.	0
TimeStamp	string	The timestamp when the monitoring data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-10-12T05:45:00Z
UpBandWidth	integer	The inbound bandwidth. Unit: bit/s.	0
MaxDownBandWidth	string	The maximum outbound bandwidth within the queried time range. Unit: bit/s.	16817468
MaxUpBandWidth	string	The maximum inbound bandwidth within the queried time range. Unit: bit/s.	231008
RequestId	string	The ID of the request.	50373E71-7710-4620-8AAB-133CCE49451C

Examples

Success response

JSON format

{
  "Code": 0,
  "MonitorData": {
    "BandWidthMonitorData": [
      {
        "DownBandWidth": 0,
        "InternetRX": 0,
        "InternetTX": 0,
        "TimeStamp": "2019-10-12T05:45:00Z",
        "UpBandWidth": 0
      }
    ],
    "MaxDownBandWidth": "16817468",
    "MaxUpBandWidth": "231008"
  },
  "RequestId": "50373E71-7710-4620-8AAB-133CCE49451C"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameters that is mandatory for processing this request is not supplied.
400	USERNOTFOUND	The user is not in ens-controller.	The current user has not registered with the edge node service or has not passed the user review.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.