ENS VM Disk and Network Resource Usage Overview - ENS

Queries the usage summary of ENS virtual machines (VMs), disks, and networks.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExpiredStartTime	string	No	The beginning of the time range to query. Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.	2018-06-15T09:07:23Z
ExpiredEndTime	string	No	The end of the time range to query. Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.	2018-06-15T09:07:23Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E RequestID.
EnsResourceUsage	array<object>	The resource usage data.
	object	Resource usage data.
ServiceType	string	The type of the service. Valid values: 1: subscription instance. 2: edge service instance. 3: pay-as-you-go instance.	1
InstanceCount	integer	The number of instances.	2
CpuSum	integer	The CPU usage. Unit: cores.	2
GpuSum	integer	The number of GPUs.	6
DownCount	integer	The number of stopped VMs.	7
ExpiredCount	integer	The number of expired VM instances.	1
ExpiringCount	integer	The number of VM instances that are about to expire.	0
RunningCount	integer	The number of running instances.	19
DiskCount	integer	The number of data disks.	4
StorageSum	integer	The total disk size.	5000
ComputeResourceCount	integer	The number of edge services. This parameter is available only when you set the ServiceType parameter to 2.	2

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\t RequestID.",
  "EnsResourceUsage": [
    {
      "ServiceType": "1",
      "InstanceCount": 2,
      "CpuSum": 2,
      "GpuSum": 6,
      "DownCount": 7,
      "ExpiredCount": 1,
      "ExpiringCount": 0,
      "RunningCount": 19,
      "DiskCount": 4,
      "StorageSum": 5000,
      "ComputeResourceCount": 2
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	ens.interface.error	An error occurred while call the API.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
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.