GetQuota - MaxCompute - Alibaba Cloud Documentation Center

Retrieve information for the specified level-1 quota group. Warning: This operation will be decommissioned on July 31, 2024. It will be replaced by the QueryQuota operation. The request parameters, response parameters, and features of the two operations are the same.

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

get

*Quota

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

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	The name of the quota.	%E9%BB%98%E8%AE%A4%E9%A2%84%E4%BB%98%E8%B4%B9Quota_p #中文名称需要经过utf8 urlencode编码转义
tenantId`deprecated`	string	No
region`deprecated`	string	No
AkProven`deprecated`	string	No
mock	boolean	No	Specifies whether to include submodules. Valid values: -true: includes submodules. -false (default): does not include submodules.	false

Response elements

Element	Type	Description	Example
	object	PopCompatibleResult
billingPolicy	object	The order information.
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
saleTag	object	The identifier of the MaxCompute quota object. This identifier is the same as the identifier in the bill of Alibaba Cloud. This parameter is used in tagging scenarios.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
cluster	string	The cluster ID.	AT-120N
createTime	integer	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The creator of the resource. This parameter is the UID of an Alibaba Cloud account.	672863518
requestId	string	The request ID.	0b87b7a316654730544735643e9200
id	string	The quota ID.	0
name	string	The quota name.	quota_a
nickName	string	The alias of the quota.	quota_nickname
parameter	object	The description of the quota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
parentId	string	The ID of the parent resource.	null
regionId	string	The region ID.	cn-beijing
scheduleInfo	object	The time-sharing information.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	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
status	string	The resource status.	ON
subQuotaInfoList	array<object>	The information about the level-2 quotas.
	object	The data.
billingPolicy	object	The order information.
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
saleTag	object	The identifier of the MaxCompute quota object. This identifier is the same as the identifier in the bill of Alibaba Cloud. This parameter is used in tagging scenarios.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
cluster	string	The cluster ID.	AT-120N
createTime	integer	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The creator of the resource. This parameter is the UID of an Alibaba Cloud account.	672863518
id	string	The level-2 quota ID.	1000048
name	string	The name of the level-2 quota.	subquotaA
nickName	string	The alias of the level-2 quota.	subquotaA
parameter	object	The description of the quota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
enablePriority	boolean	Enables the priority feature.	true
forceReservedMin	boolean	Specifies whether to enable exclusive use.	true
maxCU	integer	The upper limit of reserved computing units (CUs).	50
minCU	integer	The 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 elastic reserved CUs.	50
parentId	string	The ID of the parent resource.	0
regionId	string	The region ID.	cn-beijing
scheduleInfo	object	The time-sharing information.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	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
status	string	The resource status.	ON
tag	string	The resource tag of the quota.	abc
tenantId	string	The tenant ID.	478403690625249
type	string	This parameter corresponds to the resourceSystemType field of the control cluster.	FUXI_ONLINE
version	string	The version number.	1
tag	string	The resource tag of the quota.	abc
tenantId	string	The tenant ID.	478403690625249
type	string	This parameter corresponds to the resourceSystemType field of the control cluster.	FUXI_ONLINE
version	string	The version number.	1
data	object	The returned data.
id	string	The quota ID.	0
name	string	The quota name.	quota_a
nickName	string	The alias of the quota.	quota_nickname
type	string	This parameter corresponds to the resourceSystemType field of the control cluster.	FUXI_ONLINE
status	string	The resource status.	ON
saleTag	object	The identifier of the MaxCompute quota object. This identifier is the same as the identifier in the bill of Alibaba Cloud. This parameter is used in tagging scenarios.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
tenantId	string	The tenant ID.	478403690625249
regionId	string	The region ID.	cn-beijing
parentId	string	The ID of the parent resource.	null
cluster	string	The cluster ID.	AT-120N
version	string	The version number.	1
billingPolicy	object	The order information.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
scheduleInfo	object	The time-sharing information.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	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", }
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 parameter is the UID of an Alibaba Cloud account.	672863518
subQuotaInfoList	array<object>	The information about the level-2 quotas.
	object	The data.
id	string	The level-2 quota ID.	1000048
name	string	The name of the level-2 quota.	subquotaA
saleTag	object	The identifier of the MaxCompute quota object. This identifier is the same as the identifier in the bill of Alibaba Cloud. This parameter is used in tagging scenarios.
resourceIds	array	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.
	string	The identifier of the MaxCompute quota object. This identifier also exists in the billing subsystem of Alibaba Cloud. You can use this identifier to associate the costs of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The type of the object. Currently, only quota and project are supported.	"quota"
nickName	string	The nickname of the level-2 quota.	subquotaA
type	string	This parameter corresponds to 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 ID of the parent resource.	0
cluster	string	The cluster ID.	AT-120N
version	string	The version number.	1
billingPolicy	object	The order information.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
billingMethod	string	The billing method. subscription: indicates a subscription quota. payasyougo: indicates a pay-as-you-go quota.	subscription
scheduleInfo	object	The time-sharing information.
currPlan	string	The quota plan that is in effect based on the scheduling plan.	planA
currTime	string	The time when the currPlan was scheduled.	0800
nextPlan	string	The quota plan that is about to take effect based on the scheduling plan.	planB
nextTime	string	The time when the next_plan is scheduled.	1700
oncePlan	string	The quota plan that takes effect immediately. This parameter is not empty if a user triggers a plan that is different from the curr_plan to take effect immediately.	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.
enablePriority	boolean	Enables the priority feature.	true
forceReservedMin	boolean	Specifies whether to enable exclusive use.	true
maxCU	integer	The upper limit of reserved computing units (CUs).	50
minCU	integer	The 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 elastic reserved CUs.	50
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 parameter is the UID of an Alibaba Cloud account.	672863518

Examples

Success response

JSON format

{
  "billingPolicy": {
    "billingMethod": "subscription\n",
    "odpsSpecCode": "OdpsStandard",
    "orderId": "45245678"
  },
  "saleTag": {
    "resourceIds": [
      "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
    ],
    "resourceType": "\"quota\""
  },
  "cluster": "AT-120N",
  "createTime": 0,
  "creatorId": "672863518\n",
  "requestId": "0b87b7a316654730544735643e9200",
  "id": "0",
  "name": "quota_a\n",
  "nickName": "quota_nickname",
  "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",
  "subQuotaInfoList": [
    {
      "billingPolicy": {
        "billingMethod": "subscription",
        "odpsSpecCode": "OdpsStandard\n",
        "orderId": "45245678\n"
      },
      "saleTag": {
        "resourceIds": [
          "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
        ],
        "resourceType": "\"quota\""
      },
      "cluster": "AT-120N\n",
      "createTime": 0,
      "creatorId": "672863518\n",
      "id": "1000048\n",
      "name": "subquotaA\n",
      "nickName": "subquotaA\n",
      "parameter": {
        "enablePriority": true,
        "forceReservedMin": true,
        "maxCU": 50,
        "minCU": 50,
        "schedulerType": "Fifo/Fair",
        "singleJobCULimit": 10,
        "elasticReservedCU": 50
      },
      "parentId": "0",
      "regionId": "cn-beijing",
      "scheduleInfo": {
        "currPlan": "planA",
        "currTime": "0800",
        "nextPlan": "planB",
        "nextTime": "1700",
        "oncePlan": "planC",
        "onceTime": "1500",
        "operatorName": "userA\n",
        "timezone": "UTC+8"
      },
      "status": "ON\n",
      "tag": "abc",
      "tenantId": "478403690625249",
      "type": "FUXI_ONLINE",
      "version": "1"
    }
  ],
  "tag": "abc",
  "tenantId": "478403690625249",
  "type": "FUXI_ONLINE",
  "version": "1",
  "data": {
    "id": "0",
    "name": "quota_a",
    "nickName": "quota_nickname",
    "type": "FUXI_ONLINE",
    "status": "ON",
    "saleTag": {
      "resourceIds": [
        "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
      ],
      "resourceType": "\"quota\"\n"
    },
    "tenantId": "478403690625249",
    "regionId": "cn-beijing",
    "parentId": "null",
    "cluster": "AT-120N",
    "version": "1",
    "billingPolicy": {
      "odpsSpecCode": "OdpsStandard",
      "orderId": "45245678",
      "billingMethod": "subscription"
    },
    "scheduleInfo": {
      "currPlan": "planA",
      "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",
    "subQuotaInfoList": [
      {
        "id": "1000048",
        "name": "subquotaA",
        "saleTag": {
          "resourceIds": [
            "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
          ],
          "resourceType": "\"quota\"\n"
        },
        "nickName": "subquotaA",
        "type": "FUXI_ONLINE",
        "status": "ON",
        "tenantId": "478403690625249\n",
        "regionId": "cn-beijing",
        "parentId": "0",
        "cluster": "AT-120N\n",
        "version": "1",
        "billingPolicy": {
          "odpsSpecCode": "OdpsStandard",
          "orderId": "45245678",
          "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
        },
        "tag": "abc",
        "createTime": 0,
        "creatorId": "672863518"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.