ENS Instance Bandwidth Detail API Overview - ENS - Alibaba Cloud - ENS

Queries the bandwidth details of an instance at a 5-minute granularity.

Operation description

Request parameters act as filters. Filters are evaluated by using the logical AND operator. If a parameter is empty, the corresponding filter does not take effect. However, if InstanceIds is set to an empty JSON array, the filter is considered valid and an empty result is returned.

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:DescribeInstanceBandwidthDetail

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time in the yyyy-MM-dd HH:mm:ss format.	2024-01-11 00:00:00
EndTime	string	Yes	The end time. The maximum difference from the start time is 86400 seconds. The query range is left-closed and right-open. Format: yyyy-MM-dd HH:mm:ss.	2024-01-11 30:00:00
ServiceType	string	No	The service type, such as vm, eip, esk, or meta.	vm
InstanceType	string	No	The instance type, such as vm, eip, single_tenant, or nc. You can leave this parameter empty if no special query is required.	vm
EnsRegionId	string	No	The ENS node ID.	cn-beijing-cmcc
InstanceId	string	No	The instance ID.	i-6ecpqvkicnchxccozrpxxxx
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 200.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Bandwidths	array<object>	The collection of Internet bandwidth cap information.
	object	The collection of Internet bandwidth cap information.
InstanceId	string	The instance ID.	i-6ecpqvkicnchxccozrpxxxx
ServiceType	string	The service type, such as vm, eip, esk, or meta.	vm
InstanceType	string	The instance type, such as vm, eip, single_tenant, or nc.	vm
AliUid	integer	The user ID.	1972653484384661
EnsRegionId	string	The node ID.	cn-yichang-2
TxBw	integer	The outbound bandwidth. Unit: bit/s.	25415638
RxBw	integer	The inbound bandwidth. Unit: bit/s.	43795230
Ip	string	The IP address of the instance.	203.107.***
Isp	string	The Internet service provider (ISP) of the IP address.	cmcc
FlowType	integer	The bandwidth type. Valid values: 1: public network. 2: internal network.	1
BizTime	string	The bandwidth business time. The bandwidth calculation granularity is 5 minutes.	2024-01-11 00:00:00
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of records.	1

Examples

Success response

JSON format

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Bandwidths": [
    {
      "InstanceId": "i-6ecpqvkicnchxccozrpxxxx",
      "ServiceType": "vm",
      "InstanceType": "vm",
      "AliUid": 1972653484384661,
      "EnsRegionId": "cn-yichang-2",
      "TxBw": 25415638,
      "RxBw": 43795230,
      "Ip": "203.107.***",
      "Isp": "cmcc",
      "FlowType": 1,
      "BizTime": "2024-01-11 00:00:00"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message
400	ParamNotEnough	参数不足
400	ParamScopeError	参数值错误
400	ParamTypeError	参数类型错误
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.