QueryQuota-阿里云帮助中心

Queries the information about a specified level-1 quota group.

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

get

*Quota

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	The quota name.	%E9%BB%98%E8%AE%A4%E9%A2%84%E4%BB%98%E8%B4%B9Quota_p # The Chinese name must be encoded and escaped by using UTF-8 URL encoding.

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The tenant ID.	483212237127906
region	string	No	The region ID.	cn-chengdu
AkProven	string	No	The trusted AccessKey pairs.	null
mock	boolean	No	Specifies whether to include submodules. Valid values: true and false. -true: The request includes submodules. -false (default): The request does not include submodules.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	0bc1eeed16675342848904412e08dd
httpCode	integer	The HTTP status code.	200
errorCode	string	The error code.	success
errorMsg	string	The error message.	Exception information
data	object	The data returned.
subQuotaInfoList	array<object>	The level-2 quotas.
	array<object>	The returned data.
id	string	The ID of the level-2 quota.	1000048
name	string	The name of the level-2 quota.	subquotaA
nickName	string	The nickname of the level-2 quota.	subquotaA
type	string	This parameter corresponds to the resourceSystemType field.	FUXI_ONLINE
status	string	The status of the resource.	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 order information.
odpsSpecCode	string	The order specifications.	OdpsStandard
orderId	string	The order ID.	880c0d0d-5d79-4217-b683-8e8bdd2a2523
instanceId	string	In MaxCompute, instanceId and orderId are considered the same.	880c0d0d-5d79-4217-b683-8e8bdd2a2523
billingMethod	string	The billing method. Valid values: subscription: the subscription quota. payasyougo: the pay-as-you-go quota.	subscription
scheduleInfo	object	The information about the scheduling plan.
currPlan	string	The current quota plan that has taken effect based on the scheduling plan.	planA
currTime	string	The time when the plan specified by currPlan is scheduled.	0800
nextPlan	string	The quota plan that will take effect based on the scheduling plan.	planB
nextTime	string	The time when the plan specified by nextPlan is scheduled.	1700
oncePlan	string	The quota plan that immediately takes effect. If the quota plan specified by this parameter is triggered and the plan is different from the plan specified by currPlan, this parameter is not empty.	planC
onceTime	string	The time when the quota plan specified by oncePlan is scheduled.	1500
operatorName	string	The operator name.	userA
timezone	string	The time zone of the project.	UTC+8
parameter	object	The quota description.	{'maxCU': 10, 'minCU': 10, 'adhocCU': 0, 'schedulerType': 'Fifo'}
tag	string	The resource tag of a quota.	abc
createTime	integer	The time when the resource was created.	1688653978768
creatorId	string	The ID of the Alibaba Cloud account that is used to create the quota plan.	672863518
groupName	string	The role group name.	abc
saleTag	object	The identifiers of MaxCompute quota objects. The identifiers are the same as those in the Alibaba Cloud sales bill. This parameter is used for tags.
resourceIds	array	The identifier of a MaxCompute quota object. This identifier exists in the Alibaba Cloud sales bill. You can use this identifier to associate the cost of a quota object with a tag.
	string	The identifier of a MaxCompute quota object. This identifier exists in the Alibaba Cloud sales bill. You can use this identifier to associate the cost of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The object type. Valid values: quota and project.	"quota"
id	string	The quota ID.	2523
name	string	The quota name.	quota_a
nickName	string	The quota alias.	quota_nickname
type	string	This parameter corresponds to the resourceSystemType field.	FUXI_OFFLINE
status	string	The status of the resource.	ON
tenantId	string	The tenant ID.	478403690625249
regionId	string	The region ID.	cn-beijing
parentId	string	The parent resource ID.	null
cluster	string	The ID of the Managed Service for Prometheus cluster.	AT-120N
version	string	The version number.	1
billingPolicy	object	The order information.
odpsSpecCode	string	The order specifications.	OdpsStandard
orderId	string	The order ID.	880c0d0d-5d79-4217-b683-8e8bdd2a2523
instanceId	string	In MaxCompute, instanceId and orderId are considered the same.	880c0d0d-5d79-4217-b683-8e8bdd2a2523
billingMethod	string	The billing method. Valid values: subscription: the subscription quota. payasyougo: the pay-as-you-go quota.	subscription
scheduleInfo	object	The information about the scheduling plan.
currPlan	string	The current quota plan that has taken effect based on the scheduling plan.	planA
currTime	string	The time when the plan specified by currPlan is scheduled.	0800
nextPlan	string	The quota plan that will take effect based on the scheduling plan.	planB
nextTime	string	The time when the plan specified by nextPlan is scheduled.	1700
oncePlan	string	The quota plan that immediately takes effect. If the quota plan specified by this parameter is triggered and the plan is different from the plan specified by currPlan, this parameter is not empty.	planC
onceTime	string	The time when the quota plan specified by oncePlan is scheduled.	1500
operatorName	string	The operator name.	userA
timezone	string	The time zone of the project.	UTC+8
parameter	object	The quota description.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
tag	string	The resource tag of a quota.	abc
createTime	integer	The time when the resource was created.	1714356241163
creatorId	string	The ID of the Alibaba Cloud account that is used to create the quota plan.	1248953767546358
groupName	string	The group name.	abc
saleTag	object	The identifiers of MaxCompute quota objects. The identifiers are the same as those in the Alibaba Cloud sales bill. This parameter is used for tags.
resourceIds	array	The identifier of a MaxCompute quota object. This identifier exists in the Alibaba Cloud sales bill. You can use this identifier to associate the cost of a quota object with a tag.
	string	The identifier of a MaxCompute quota object. This identifier exists in the Alibaba Cloud sales bill. You can use this identifier to associate the cost of a quota object with a tag.	"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"
resourceType	string	The object type. Valid values: quota and project.	project

Examples

Success response

JSON format

{
  "requestId": "0bc1eeed16675342848904412e08dd",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "Exception information",
  "data": {
    "subQuotaInfoList": [
      {
        "id": "1000048",
        "name": "subquotaA",
        "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": "880c0d0d-5d79-4217-b683-8e8bdd2a2523",
          "instanceId": "880c0d0d-5d79-4217-b683-8e8bdd2a2523",
          "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": 1688653978768,
        "creatorId": "672863518",
        "groupName": "abc",
        "saleTag": {
          "resourceIds": [
            "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
          ],
          "resourceType": "\"quota\"\n"
        }
      }
    ],
    "id": "2523",
    "name": "quota_a",
    "nickName": "quota_nickname",
    "type": "FUXI_OFFLINE",
    "status": "ON",
    "tenantId": "478403690625249",
    "regionId": "cn-beijing",
    "parentId": "null",
    "cluster": "AT-120N",
    "version": "1",
    "billingPolicy": {
      "odpsSpecCode": "OdpsStandard",
      "orderId": "880c0d0d-5d79-4217-b683-8e8bdd2a2523",
      "instanceId": "880c0d0d-5d79-4217-b683-8e8bdd2a2523",
      "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": 1714356241163,
    "creatorId": "1248953767546358",
    "groupName": "abc",
    "saleTag": {
      "resourceIds": [
        "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
      ],
      "resourceType": "project"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.