All Products
Search
Document Center

ENS:DescribeEnsResourceUsage

Last Updated:Mar 12, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ExpiredStartTimestringNo

The beginning of the time range to query. Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.

2018-06-15T09:07:23Z
ExpiredEndTimestringNo

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 parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

EnsResourceUsageobject []

The resource usage data.

ServiceTypestring

The type of the service. Valid values:

  • 1: subscription instance.
  • 2: edge service instance.
  • 3: pay-as-you-go instance.
1
InstanceCountinteger

The number of instances.

2
CpuSumlong

The CPU usage. Unit: cores.

2
GpuSumlong

The number of GPUs.

6
DownCountinteger

The number of stopped VMs.

7
ExpiredCountinteger

The number of expired VM instances.

1
ExpiringCountinteger

The number of VM instances that are about to expire.

0
RunningCountinteger

The number of running instances.

19
DiskCountinteger

The number of data disks.

4
StorageSumlong

The total disk size.

5000
ComputeResourceCountinteger

The number of edge services. This parameter is available only when you set the ServiceType parameter to 2.

2

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400ens.interface.errorAn error occurred while call the API.
400Invalid%sThe specified parameter %s is invalid.
400Missing%sYou must specify the parameter %s.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
No change history