Use DescribePrePaidInstanceStock to query subscription resource stock - 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:DescribePrePaidInstanceStock

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	Yes	The ID of the edge node.	cn-suzhou-telecom
SystemDiskSize	integer	Yes	The size of the system disk. Unit: GB.	100
DataDiskSize	integer	Yes	The size of the data disk. Unit: GB.	20
InstanceSpec	string	Yes	The specification of the instance.	ens.sn1.stiny

Response elements

Element	Type	Description	Example
	object
AvaliableCount	integer	The number of resources that you can purchase.	84
Cores	integer	The number of CPU cores.	1
DataDiskSize	integer	The size of the data disk.	20
EnsRegionId	string	The ID of the node.	cn-suzhou-telecom
InstanceSpec	string	The specification of the instance.	ens.sn1.stiny
Memory	integer	The memory size. Unit: GB.	2048
RequestId	string	The request ID.	007833C8-E819-4122-B636-0D48D7BF6DFB
SystemDiskSize	integer	The size of the system disk.	20
ResourceGap	string	The reason why resources are insufficient.	StockNotEnough

Examples

Success response

JSON format

{
  "AvaliableCount": 84,
  "Cores": 1,
  "DataDiskSize": 20,
  "EnsRegionId": "cn-suzhou-telecom",
  "InstanceSpec": "ens.sn1.stiny",
  "Memory": 2048,
  "RequestId": "007833C8-E819-4122-B636-0D48D7BF6DFB",
  "SystemDiskSize": 20,
  "ResourceGap": "StockNotEnough"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InventoryExceeded	The Instance in stock are insufficient,please submit a ticket.	The specified instance resource inventory is insufficient, please re-match.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.