DocsICP FilingConsole
Documentation

ListQuotas

Updated at:
Copy as MD
Product
My Favorites

Lists quotas.

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

pai:ListQuotas

list

*All Resource

*

 None None

Request syntax

GET /api/v1/quotas/ HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
QuotaName

string

No

Filters the results by quota name. Fuzzy matching is supported.

quotajradxh43rgb
ResourceType

string

No

The resource type. Valid values are Lingjun, ECS, and ACS. The default value is ECS.

ECS
LayoutMode

string

No

The layout mode. Valid values: Tree and List.

Tree
ParentQuotaId

string

No

Filters the results by parent quota ID:

  • If this parameter is not specified, all quotas within the tenant are returned, including both root and child quotas.

  • If this parameter is set to an empty string, all root quotas are returned.

  • If a specific parent quota ID is provided, all child quotas of that parent are returned.

quotajradxh43rgb
QuotaIds

string

No

A comma-separated list of up to 100 quota IDs to filter the results. Only exact matching is supported.

quota1ci8g793pgm,quotajradxh43rgb
WorkspaceIds

string

No

A comma-separated list of up to 10 workspace IDs to filter the results. Only exact matching is supported.

21345,38727
Statuses

string

No

A comma-separated list of quota statuses to filter the results. Only exact matching is supported.

Creating
PageNumber

integer

No

The page number of the results to return. The minimum value is 1.

1
PageSize

integer

No

The number of entries to return on each page. The minimum value is 1.

20
SortBy

string

No

The field to sort the results by. Valid values:

  • QuotaName

  • Status

  • CPU

  • Memory

  • GPU

  • GmtCreatedTime

  • GmtModifiedTime

status
Order

string

No

The sort order. Valid values are desc and asc.

desc
Labels

string

No

Filters the results by labels. Specify labels as key=value pairs, separated by commas (,).

official=true,gpu=false
Verbose

boolean

No

Specifies whether to return detailed information. Valid values:

  • true: Returns detailed information.

  • false: Does not return detailed information.

true
WorkspaceName

string

No

The name of the associated workspace.

myshellprod
HasResource

string

No

Versions

string

No

Filters the results by version.

1.0
ClusterType

string

No

Filters the results by cluster type.

RayCluster
GPUType

string

No

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The request ID.

F082BD0D-21E1-5F9B-81A0-AB07485B03CD
Quotas

array

The list of quotas.

Quota

The details of a quota.

TotalCount

integer

The total number of entries that match the request.

23

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.