ListQuotas - MaxCompute - Alibaba Cloud Documentation Center

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

odps:ListQuotas

get

*Quota

acs:odps:{#regionId}:{#accountId}:quotas/*

None

Request syntax

GET /api/v1/quotas HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
tenantId`deprecated`	string	No
region`deprecated`	string	No
productId`deprecated`	string	No
billingType	string	No	The billing method.	subscription
saleTags	string	No	The cost allocation tags that are used to filter quotas. You can create cost allocation tags in the Tag service.	{"tag":"this_is_tag_demo"}
marker	string	No	The token that specifies the position from which to start returning results. The results are sorted in alphabetical order.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	No	The maximum number of entries to return on each page.	100

Response elements

Element	Type	Description	Example
	object	PopCompatibleResult
requestId	string	The ID of the request.	0bc12e6f16677875480593081d2956
quotaInfoList	array<object>	The list of quotas.
	array<object>	The list of quotas.
billingPolicy	object	The billing information.
billingMethod	string	The billing method. subscription: The subscription billing method. payasyougo: The pay-as-you-go billing method.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The ID of the order.	45245678
saleTag	object	The sales tag of the quota. This tag is the same as the billing identifier and is used for cost allocation.
resourceIds	array	The IDs of the resources. This ID is also used in the billing system. You can use this ID to associate the costs of a quota with a tag.
	string	The ID of the MaxCompute quota.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the resource. Valid values: quota and project.	"project"
cluster	string	The ID of the cluster.	AT-120N
createTime	integer	The time when the quota was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the account that created the quota. This ID is an Alibaba Cloud account UID.	672863518
id	string	The ID of the quota.	0
name	string	The name of the quota.	quota_a
nickName	string	The alias of the quota.	quota_nickname
parameter	object	The parameters of the quota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
parentId	string	The ID of the parent resource.	null
regionId	string	The ID of the region.	cn-beijing
scheduleInfo	object	The time-based scheduling information.
currPlan	string	The quota plan that is currently in effect.	planA
currTime	string	The time when the current plan took effect.	0800
nextPlan	string	The next quota plan that is scheduled to take effect.	planB
nextTime	string	The time when the next plan is scheduled to take effect.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is returned only when a user triggers an immediate plan that is different from the current plan.	planC
onceTime	string	The time when the immediate plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
status	string	The status of the quota.	ON
subQuotaInfoList	array<object>	The information about the sub-quotas.
	array<object>	The information about the sub-quotas.
saleTag	object	The sales tag of the quota. This tag is the same as the billing identifier and is used for cost allocation.
resourceIds	array	The IDs of the resources. This ID is also used in the billing system. You can use this ID to associate the costs of a quota with a tag.
	string	The ID of the MaxCompute quota.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the resource. Valid values: quota and project.	"quota"
billingPolicy	object	The billing information.
billingMethod	string	The billing method. subscription: The subscription billing method. payasyougo: The pay-as-you-go billing method.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The ID of the order.	45245678
cluster	string	The ID of the cluster.	AT-120N
createTime	integer	The time when the quota was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the account that created the quota. This ID is an Alibaba Cloud account UID.	672863518
id	string	The ID of the sub-quota.	1000048
name	string	The name of the sub-quota.	subquotaA
nickName	string	The alias of the sub-quota.	subquotaA
parameter	object	The quota description.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
enablePriority	boolean	Indicates whether to enable priority-based scheduling.	true
forceReservedMin	boolean	Indicates whether the resource is exclusive.	true
maxCU	integer	The maximum reserved computing units (CUs).	50
minCU	integer	The minimum reserved CUs.	50
schedulerType	string	The scheduling policy.	Fifo/Fair
singleJobCULimit	integer	The maximum CUs for a single job.	10
elasticReservedCU	integer	The elastically reserved CUs.	50
slotNum	integer
adhocSlot	integer
minGu	integer
maxGu	integer
autoScaleCPULimit	integer
parentId	string	The ID of the parent resource.	0
regionId	string	The ID of the region.	cn-beijing
scheduleInfo	object	The time-based scheduling information.
currPlan	string	The quota plan that is currently in effect.	planA
currTime	string	The time when the current plan took effect.	0800
nextPlan	string	The next quota plan that is scheduled to take effect.	planB
nextTime	string	The time when the next plan is scheduled to take effect.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is returned only when a user triggers an immediate plan that is different from the current plan.	planC
onceTime	string	The time when the immediate plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
status	string	The status of the quota.	ON
tag	string	The tag of the quota.	abc
tenantId	string	The ID of the tenant.	280747109771520
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the control cluster.	FUXI_ONLINE
version	string	The version number.	1
tag	string	The tag of the quota.	abc
tenantId	string	The ID of the tenant.	280747109771520
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the control cluster.	FUXI_ONLINE
version	string	The version number.	1
Tags	array<object>	The tags.
	object	The tags.
TagValue	string	The value of the tag.	1
TagKey	string	The key of the tag.	Department
marker	string	The token that specifies the position from which to start returning results. The results are sorted in alphabetical order.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	The maximum number of entries returned on each page.	10
data	object	The data returned.
quotaInfoList	array<object>	The list of quotas.
	array<object>	The list of quotas.
id	string	The ID of the quota.	0
name	string	The name of the quota.	quota_a
nickName	string	The alias of the quota.	quota_nickname
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the control cluster.	FUXI_ONLINE
status	string	The status of the quota.	ON
tenantId	string	The ID of the tenant.	280747109771520
regionId	string	The ID of the region.	cn-beijing
parentId	string	The ID of the parent resource.	null
cluster	string	The ID of the cluster.	AT-120N
version	string	The version number.	1
billingPolicy	object	The billing information.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The ID of the order.	45245678
billingMethod	string	The billing method. subscription: The subscription billing method. payasyougo: The pay-as-you-go billing method.	subscription
scheduleInfo	object	The time-based scheduling information.
currPlan	string	The quota plan that is currently in effect.	planA
currTime	string	The time when the current plan took effect.	0800
nextPlan	string	The next quota plan that is scheduled to take effect.	planB
nextTime	string	The time when the next plan is scheduled to take effect.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is returned only when a user triggers an immediate plan that is different from the current plan.	planC
onceTime	string	The time when the immediate plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
parameter	object	The quota description.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
tag	string	The tag of the quota.	abc
createTime	integer	The time when the quota was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the account that created the quota. This ID is an Alibaba Cloud account UID.	672863518
saleTag	object	The sales tag of the quota. This tag is the same as the billing identifier and is used for cost allocation.
resourceIds	array	The IDs of the resources. This ID is also used in the billing system. You can use this ID to associate the costs of a quota with a tag.
	string	The ID of the MaxCompute quota.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the resource. Valid values: quota and project.	"quota"
subQuotaInfoList	array<object>	The information about the sub-quotas.
	array<object>	The information about the sub-quotas.
id	string	The ID of the sub-quota.	1000048
name	string	The name of the sub-quota.	subquotaA
nickName	string	The alias of the sub-quota.	subquotaA
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the control cluster.	FUXI_ONLINE
status	string	The status of the quota.	ON
tenantId	string	The ID of the tenant.	280747109771520
regionId	string	The ID of the region.	cn-beijing
parentId	string	The ID of the parent resource.	0
cluster	string	The ID of the cluster.	AT-120N
version	string	The version number.	1
billingPolicy	object	The billing information.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The ID of the order.	45245678
billingMethod	string	The billing method. subscription: The subscription billing method. payasyougo: The pay-as-you-go billing method.	subscription
scheduleInfo	object	The time-based scheduling information.
currPlan	string	The quota plan that is currently in effect.	planA
currTime	string	The time when the current plan took effect.	0800
nextPlan	string	The next quota plan that is scheduled to take effect.	planB
nextTime	string	The time when the next plan is scheduled to take effect.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is returned only if a user triggers an immediate plan that is different from `currPlan`.	planC
onceTime	string	The time when the immediate-effect plan was triggered.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone.	UTC+8
parameter	object	The description of the quota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
enablePriority	boolean	Specifies whether to enable priority-based scheduling.	true
forceReservedMin	boolean	Specifies whether the resource is exclusive.	true
maxCU	integer	The upper limit of reserved CUs.	50
minCU	integer	The minimum number of guaranteed reserved CUs.	50
schedulerType	string	The scheduling policy.	Fifo/Fair
singleJobCULimit	integer	The upper limit of CUs for a single job.	10
elasticReservedCU	integer	The value of elastically reserved CUs.	50
slotNum	integer
adhocSlot	integer
autoScaleCPULimit	integer
minGu	integer
maxGu	integer
tag	string	The resource tag of the quota.	abc
createTime	integer	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The creator of the resource. This is the UID of an Alibaba Cloud account.	672863518
saleTag	object	The identifier of the MaxCompute quota object. This identifier is the same as the one in the Alibaba Cloud bill and is used in tagging scenarios.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the Alibaba Cloud sales subsystem. It associates the costs of the quota object with a tag.
	string	The identifier of the MaxCompute quota object.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Only `quota` and `project` are supported.	"quota"
Tags	array<object>	The tags.
	object	The tag.
TagValue	string	The tag value.	a12351qHDP6YEQMt
TagKey	string	The tag key.	Department
marker	string	The results are returned in alphabetical order, starting from the entry after the marker.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	The maximum number of entries returned per page.	10
NextToken	string	The token for the next page of results. If this parameter has a value, more results are available. To get the next page, include this value in the `NextToken` parameter of the next request.	"abcde"
NextToken	string	The token for the next page of results. This operation supports only consecutive paging. If the returned value is not empty, more data is available. To get the next page, use the returned value in your next request.	AAAAAdDWBF2w6Olxc+cMPjUtUMo/CvPe4IK7f7kIQFrIZjyc

Examples

Success response

JSON format

{
  "requestId": "0bc12e6f16677875480593081d2956",
  "quotaInfoList": [
    {
      "billingPolicy": {
        "billingMethod": "subscription",
        "odpsSpecCode": "OdpsStandard ",
        "orderId": "45245678"
      },
      "saleTag": {
        "resourceIds": [
          "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\""
        ],
        "resourceType": "\"project\""
      },
      "cluster": "AT-120N\n",
      "createTime": 0,
      "creatorId": "672863518\n",
      "id": "0",
      "name": "quota_a\n",
      "nickName": "quota_nickname\n",
      "parameter": {
        "test": "test",
        "test2": 1
      },
      "parentId": "null",
      "regionId": "cn-beijing",
      "scheduleInfo": {
        "currPlan": "planA",
        "currTime": "0800",
        "nextPlan": "planB",
        "nextTime": "1700",
        "oncePlan": "planC",
        "onceTime": "1500",
        "operatorName": "userA",
        "timezone": "UTC+8"
      },
      "status": "ON \n",
      "subQuotaInfoList": [
        {
          "saleTag": {
            "resourceIds": [
              "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
            ],
            "resourceType": "\"quota\""
          },
          "billingPolicy": {
            "billingMethod": "subscription\n",
            "odpsSpecCode": "OdpsStandard ",
            "orderId": "45245678\n"
          },
          "cluster": "AT-120N",
          "createTime": 0,
          "creatorId": "672863518\n",
          "id": "1000048",
          "name": "subquotaA\n",
          "nickName": "subquotaA\n",
          "parameter": {
            "enablePriority": true,
            "forceReservedMin": true,
            "maxCU": 50,
            "minCU": 50,
            "schedulerType": "Fifo/Fair\n",
            "singleJobCULimit": 10,
            "elasticReservedCU": 50,
            "slotNum": 0,
            "adhocSlot": 0,
            "minGu": 0,
            "maxGu": 0,
            "autoScaleCPULimit": 0
          },
          "parentId": "0",
          "regionId": "cn-beijing",
          "scheduleInfo": {
            "currPlan": "planA",
            "currTime": "0800",
            "nextPlan": "planB",
            "nextTime": "1700",
            "oncePlan": "planC",
            "onceTime": "1500",
            "operatorName": "userA",
            "timezone": "UTC+8"
          },
          "status": "ON",
          "tag": "abc",
          "tenantId": "280747109771520\n",
          "type": "FUXI_ONLINE\n",
          "version": "1"
        }
      ],
      "tag": "abc",
      "tenantId": "280747109771520\n",
      "type": "FUXI_ONLINE\n",
      "version": "1",
      "Tags": [
        {
          "TagValue": "1",
          "TagKey": "Department"
        }
      ]
    }
  ],
  "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
  "maxItem": 10,
  "data": {
    "quotaInfoList": [
      {
        "id": "0\n",
        "name": "quota_a\n",
        "nickName": "quota_nickname",
        "type": "FUXI_ONLINE",
        "status": "ON",
        "tenantId": "280747109771520",
        "regionId": "cn-beijing",
        "parentId": "null",
        "cluster": "AT-120N",
        "version": "1",
        "billingPolicy": {
          "odpsSpecCode": "OdpsStandard ",
          "orderId": "45245678\n",
          "billingMethod": "subscription"
        },
        "scheduleInfo": {
          "currPlan": "planA\n",
          "currTime": "0800",
          "nextPlan": "planB",
          "nextTime": "1700",
          "oncePlan": "planC",
          "onceTime": "1500",
          "operatorName": "userA",
          "timezone": "UTC+8"
        },
        "parameter": {
          "test": "test",
          "test2": 1
        },
        "tag": "abc",
        "createTime": 0,
        "creatorId": "672863518\n",
        "saleTag": {
          "resourceIds": [
            "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
          ],
          "resourceType": "\"quota\"\n"
        },
        "subQuotaInfoList": [
          {
            "id": "1000048",
            "name": "subquotaA\n",
            "nickName": "subquotaA\n",
            "type": "FUXI_ONLINE\n",
            "status": "ON",
            "tenantId": "280747109771520\n",
            "regionId": "cn-beijing",
            "parentId": "0",
            "cluster": "AT-120N",
            "version": "1",
            "billingPolicy": {
              "odpsSpecCode": "OdpsStandard ",
              "orderId": "45245678\n",
              "billingMethod": "subscription"
            },
            "scheduleInfo": {
              "currPlan": "planA",
              "currTime": "0800",
              "nextPlan": "planB",
              "nextTime": "1700",
              "oncePlan": "planC",
              "onceTime": "1500",
              "operatorName": "userA",
              "timezone": "UTC+8"
            },
            "parameter": {
              "enablePriority": true,
              "forceReservedMin": true,
              "maxCU": 50,
              "minCU": 50,
              "schedulerType": "Fifo/Fair\n",
              "singleJobCULimit": 10,
              "elasticReservedCU": 50,
              "slotNum": 0,
              "adhocSlot": 0,
              "autoScaleCPULimit": 0,
              "minGu": 0,
              "maxGu": 0
            },
            "tag": "abc",
            "createTime": 0,
            "creatorId": "672863518\n",
            "saleTag": {
              "resourceIds": [
                "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
              ],
              "resourceType": "\"quota\"\n"
            }
          }
        ],
        "Tags": [
          {
            "TagValue": "a12351qHDP6YEQMt",
            "TagKey": "Department"
          }
        ]
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "\"abcde\""
  },
  "NextToken": "AAAAAdDWBF2w6Olxc+cMPjUtUMo/CvPe4IK7f7kIQFrIZjyc"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.