DescribeCloudDiskAvailableResourceInfo API Reference - ENS

Queries the available resources in a region.

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

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0AE4F26E-7527-569F-A987-E3CF269A3C11
SupportResources	object
SupportResource	array<object>	The specifications of resources that you can purchase.
	array<object>	The specifications of resource that you can purchase.
EnsRegionId	string	The ID of the edge node.	cn-beijing-cmcc
EnsRegionName	string	The name of the task node.	BeijingMobile
DiskMinSize	integer	The minimum size of the disk size. Unit: GiB.	20
DiskMaxSize	integer	The maximum size of the disk. Unit: GiB.	80
CanBuyCount	integer	The number of disks that you can purchase.	2
Category	string	The type of the disk. cloud_efficiency:ultra disk. cloud_ssd:all-flash disk. local_hdd:local HDD. local_ssd:local SSD.	cloud_ssd
DefaultDiskSize	integer	The default size of the disk. Unit: GiB.	20
Ability	object
Ability	array	Node product capability.
	string	Node product capability.	cloud_efficiency:High-efficiency cloud disk cloud_ssd:All-flash cloud disk

Examples

Success response

JSON format

{
  "RequestId": "0AE4F26E-7527-569F-A987-E3CF269A3C11",
  "SupportResources": {
    "SupportResource": [
      {
        "EnsRegionId": "cn-beijing-cmcc",
        "EnsRegionName": "BeijingMobile",
        "DiskMinSize": 20,
        "DiskMaxSize": 80,
        "CanBuyCount": 2,
        "Category": "cloud_ssd",
        "DefaultDiskSize": 20,
        "Ability": {
          "Ability": [
            "cloud_efficiency:High-efficiency cloud disk\ncloud_ssd:All-flash cloud disk"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	Missing%s	You must specify the parameter %s.
400	Invalid%s	The specified parameter %s is invalid.
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.