ListQuotas API Overview for PAI Resource Quota Management - Platform for AI

Retrieves a list of resource 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

Request syntax

GET /api/v1/quotas HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the resource quota. Fuzzy search is supported.	quota-name

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Quotas	array<object>	The list of resource quotas.
	array<object>	The details of the resource quota.
QuotaType	string	The type of the resource quota. Valid value: PAI: a GPU resource group cluster of MaxCompute.	PAI
Mode	string	The billing method. Valid values: isolate: subscription. share: pay-as-you-go.	isolate
ProductCode	string	The product name. Valid values: PAI_isolate: a subscription PAI resource group (PAI CPU). PAI_share: a pay-as-you-go PAI resource group (PAI GPU).	PAI_share
Name	string	The quota name.	quota-name
Specs	array<object>	The list of specification descriptions.	{\"cu\":\"11500\",\"minCu\":\"2300\",\"parentId\":\"0\"}
	object	The specification description.
Name	string	The specification name.	cu
Value	string	The specification value.	11500
Type	string	The type. This parameter can be empty.	string
Id	string	The quota ID.	1828233
DisplayName	string	The alias of the resource quota.	默认Quota。
TotalCount	integer	The number of resource quotas that meet the filter condition.	1

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Quotas": [
    {
      "QuotaType": "PAI",
      "Mode": "isolate",
      "ProductCode": "PAI_share",
      "Name": "quota-name",
      "Specs": [
        {
          "Name": "cu",
          "Value": "11500",
          "Type": "string"
        }
      ],
      "Id": "1828233",
      "DisplayName": "默认Quota。"
    }
  ],
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.