GetComputeQuotaPlan-阿里云帮助中心

Get detailed information of a single compute quota plan.

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

get

*Quota

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	The nickname of level-1 compute quota.	os_ComputeQuota_p
planName	string	Yes	The name of quota plan.	planA

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	EA1320AB-7766-5EC7-B0F6-8B20E2298567
httpCode	integer	The HTTP status code. 1xx: informational response. The request is received and is being processed. 2xx: success. The request is successfully received, understood, and accepted by the server. 3xx: redirection. The request is redirected, and further actions are required to complete the request. 4xx: client error. The request contains invalid request parameters or syntaxes, or specific request conditions cannot be met. 5xx: server error. The server cannot meet requirements due to other reasons.	200
errorCode	string	The error code.	QUOTA_PLAN_NOT_FOUND
errorMsg	string	The error message.	plan \"***\" does not exist
data	object	The data returned.
name	string	The name of the quota plan.	planA
createTime	string	The time when the quota plan was created.	1730946421757
quota	object	The details of the quota.
subQuotaInfoList	array<object>	The list of level-2 quotas.
	array<object>
id	string	The ID of the level-2 quota.	10940
name	string	The name of the level-2 quota.	dp_cn_shanghai_1696659792_p
nickName	string	The nickname of the level-2 quota.	subquotaA
type	string	The type of quota.	FUXI_ONLINE
status	string	Resource status.	ON
tenantId	string	Tenant ID.	478403690625249
regionId	string	Region ID.	cn-beijing
cluster	string	Cluster ID.	AT-120N
version	string	Version number.	1386
parameter	object	The parameters of the level-2 quota.
elasticReservedCU	integer	The value of elastic Reserved CUs.	50
maxCU	integer	The value of maxCU in Reserved CUs.	50
minCU	integer	The value of minCU in Reserved CUs.	50
schedulerType	string	Scheduling policy.	Fifo/Fair
singleJobCULimit	integer	The upper limit for CUs that can be concurrently used by a job scheduled to the quota.	50
forceReservedMin	boolean	Whether it is exclusive.	true/false
enablePriority	boolean	whether to enable the priority feature.	true/false
createTime	integer	Creation time.	1718155201628
creatorId	string	Creator cloud account UID.	672863518
id	string	The ID of the level-1 quota.	2413
name	string	The name of the level-1 quota.	quota_a
nickName	string	The nickname of the level-1 quota.	quota_nickname
type	string	Corresponds to the `resourceSystemType` field of the control cluster.	FUXI_ONLINE
status	string	Resource status.	ON
tenantId	string	Tenant ID.	478403690625249
regionId	string	Region ID.	cn-beijing
cluster	string	Cluster ID.	AT-120N
version	string	Version number.	1964
parameter	object	CU value parameters for the level-1 quota.
maxCU	integer	The value of maxCU in Reserved CUs.	50
minCU	integer	The value of minCU in Reserved CUs.	50
elasticReservedCU	integer	The value of elastic Reserved CUs.	50
createTime	integer	Creation time.	1719886322347
creatorId	string	Creator's cloud account UID.	672863518
isEffective	boolean	Whether it is currently effective. Note A Quota plan that has taken effect cannot be deleted, i.e., isEffective=true	true/false

Examples

Success response

JSON format

{
  "requestId": "EA1320AB-7766-5EC7-B0F6-8B20E2298567",
  "httpCode": 200,
  "errorCode": "QUOTA_PLAN_NOT_FOUND",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "name": "planA",
    "createTime": "1730946421757",
    "quota": {
      "subQuotaInfoList": [
        {
          "id": "10940",
          "name": "dp_cn_shanghai_1696659792_p",
          "nickName": "subquotaA",
          "type": "FUXI_ONLINE",
          "status": "ON",
          "tenantId": "478403690625249",
          "regionId": "cn-beijing",
          "cluster": "AT-120N\n",
          "version": "1386",
          "parameter": {
            "elasticReservedCU": 50,
            "maxCU": 50,
            "minCU": 50,
            "schedulerType": "Fifo/Fair",
            "singleJobCULimit": 50,
            "forceReservedMin": true,
            "enablePriority": true
          },
          "createTime": 1718155201628,
          "creatorId": "672863518"
        }
      ],
      "id": "2413",
      "name": "quota_a\n",
      "nickName": "quota_nickname",
      "type": "FUXI_ONLINE",
      "status": "ON",
      "tenantId": "478403690625249",
      "regionId": "cn-beijing",
      "cluster": "AT-120N\n",
      "version": "1964",
      "parameter": {
        "maxCU": 50,
        "minCU": 50,
        "elasticReservedCU": 50
      },
      "createTime": 1719886322347,
      "creatorId": "672863518"
    },
    "isEffective": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.