Obtain quota plans by calling ListQuotasPlans - MaxCompute - Alibaba Cloud - MaxCompute

Queries the list of quota plans for a specified quota.

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

get

*Quota

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

None

Request syntax

GET /api/v1/quotas/{nickname}/plans HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	The quota name.	quotaA

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The tenant ID.	478403690625249
region	string	No	The region ID.	cn-beijing

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	The request ID.	0be3e0bd16661643917136451ebf55
data	object	The returned data.
planList	array<object>	The list of quota plans.
	array<object>	The data.
name	string	The quota plan name.	planA
createTime	string	The time when the quota plan was created.	2022-05-16T06:07:45Z
quota	object	The quota details.
id	string	The quota ID.	0
name	string	The quota name.	quota_a
nickName	string	The quota alias.	quota_nickname
type	string	The resourceSystemType field of the control cluster.	FUXI_ONLINE
status	string	The resource status.	ON
tenantId	string	The tenant ID.	478403690625249
regionId	string	The region ID.	cn-beijing
parentId	string	The parent resource ID.	null
cluster	string	The cluster ID.	AT-120N
version	string	The version.	1
billingPolicy	object	The billing information.
odpsSpecCode	string	The specification code.	OdpsStandard
orderId	string	The order ID.	45245678
billingMethod	string	The billing method. subscription: indicates a subscription (prepaid) quota. payasyougo: indicates a pay-as-you-go (postpaid) quota.	subscription
scheduleInfo	object	The scheduling information.
currPlan	string	The quota plan that takes effect based on the scheduling configuration.	planA
currTime	string	The time when currPlan is scheduled to take effect.	0800
nextPlan	string	The next quota plan to take effect based on the scheduling configuration.	planB
nextTime	string	The time when nextPlan is scheduled to take effect.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if the triggered plan differs from currPlan.	planC
onceTime	string	The time when the immediate plan was triggered.	1500
operatorName	string	The operator name.	userA
parameter	object	The quota description.
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 resource creator, which is the UID of the Alibaba Cloud account.	672863518
subQuotaInfoList	array<object>	The level-2 quota information.
	array<object>	The level-2 quota information.
id	string	The level-2 quota ID.	1000048
name	string	The level-2 quota name.	subquotaA
nickName	string	The level-2 quota alias.	subquotaA
type	string	The resourceSystemType field of the control cluster.	FUXI_ONLINE
status	string	The resource status.	ON
tenantId	string	The tenant ID.	478403690625249
regionId	string	The region ID.	cn-beijing
parentId	string	The parent resource ID.	0
cluster	string	The cluster ID.	AT-120N
version	string	The version number.	1
billingPolicy	object	The billing information.
odpsSpecCode	string	The specification code.	OdpsStandard
orderId	string	The order ID.	45245678
billingMethod	string	The billing method. subscription: indicates a subscription (prepaid) quota. payasyougo: indicates a pay-as-you-go (postpaid) quota.	subscription
scheduleInfo	object	The scheduling information.
currPlan	string	The quota plan that takes effect based on the scheduling configuration.	planA
currTime	string	The time when currPlan is scheduled to take effect.	0800
nextPlan	string	The next quota plan to take effect based on the scheduling configuration.	planB
nextTime	string	The time when nextPlan is scheduled to take effect.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if the triggered plan differs from currPlan.	planC
onceTime	string	The time when the immediate plan was triggered.	1500
operatorName	string	The operator name.	userA
parameter	object	The quota description.
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 resource creator, which is the UID of the Alibaba Cloud account.	672863518

Examples

Success response

JSON format

{
  "requestId": "0be3e0bd16661643917136451ebf55",
  "data": {
    "planList": [
      {
        "name": "planA",
        "createTime": "2022-05-16T06:07:45Z\n",
        "quota": {
          "id": "0",
          "name": "quota_a",
          "nickName": "quota_nickname",
          "type": "FUXI_ONLINE",
          "status": "ON",
          "tenantId": "478403690625249",
          "regionId": "cn-beijing",
          "parentId": "null",
          "cluster": "AT-120N\n",
          "version": "1",
          "billingPolicy": {
            "odpsSpecCode": "OdpsStandard ",
            "orderId": "45245678",
            "billingMethod": "subscription"
          },
          "scheduleInfo": {
            "currPlan": "planA",
            "currTime": "0800\n",
            "nextPlan": "planB",
            "nextTime": "1700",
            "oncePlan": "planC",
            "onceTime": "1500",
            "operatorName": "userA"
          },
          "parameter": {
            "test": "test",
            "test2": 1
          },
          "tag": "abc",
          "createTime": 0,
          "creatorId": "672863518",
          "subQuotaInfoList": [
            {
              "id": "1000048",
              "name": "subquotaA",
              "nickName": "subquotaA",
              "type": "FUXI_ONLINE",
              "status": "ON",
              "tenantId": "478403690625249",
              "regionId": "cn-beijing",
              "parentId": "0",
              "cluster": "AT-120N\n",
              "version": "1",
              "billingPolicy": {
                "odpsSpecCode": "OdpsStandard ",
                "orderId": "45245678",
                "billingMethod": "subscription\n"
              },
              "scheduleInfo": {
                "currPlan": "planA",
                "currTime": "0800",
                "nextPlan": "planB",
                "nextTime": "1700",
                "oncePlan": "planC",
                "onceTime": "1500",
                "operatorName": "userA"
              },
              "parameter": {
                "test": "test",
                "test2": 1
              },
              "tag": "abc",
              "createTime": 0,
              "creatorId": "672863518"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.