Retrieve Effective Compute Quota Plan via API - MaxCompute - Alibaba Cloud - MaxCompute

获取当前生效的计算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:GetEffectivePlan

get

*QuotaPlan

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	一级 Quota 昵称。	os_ComputeQuota_p

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	请求返回参数。
requestId	string	请求 ID。	688003E1-D1B4-5468-957E-2FFB3AC8D79B
httpCode	integer	HTTP 状态码。 1xx：信息响应 - 请求已接收，正在处理中。 2xx：成功 - 请求动作已被服务端成功接收、理解并接受。 3xx：重定向 - 请求被重定向，采取进一步行动以完成请求。 4xx：客户端错误 - 请求包含错误请求参、语法或特定请求条件无法满足。 5xx：服务端错误 - 服务器由于其他原因无法满足请求。	200
errorCode	string	错误码。	success
errorMsg	string	错误信息。	plan \"***\" does not exist
data	object	返回结果。
name	string	Quota 计划名称。	planA
createTime	string	创建时间。	1714356241163
quota	object	Quota 属性。
subQuotaInfoList	array<object>	二级 Quota 列表。
	array<object>
id	string	二级 quota ID。	10940
name	string	二级 Quota 名称。	dp_cn_shanghai_1696659792_p
nickName	string	二级 Quota 昵称。	os_MyQuota
type	string	Quota 类型。	FUXI_ONLINE
status	string	资源状态。	ON
tenantId	string	租户 ID。	478403690625249
regionId	string	地域 ID。	cn-beijing
cluster	string	集群 ID。	AT-120N
version	string	版本号。	1386
parameter	object	Quota 配置参数。	{ "enablePriority": false, "minCU": 25, "adhocCU": 0, "elasticReservedCU": 0, "forceReservedMin": false, "maxCU": 50, "schedulerType": "Fifo" }
createTime	integer	创建时间。	1718155201628
creatorId	string	创建者 id。	672863518
id	string	一级 Quota ID。	2413
name	string	一级 Quota 名称。	dp_cn_shanghai_1699533470_p
nickName	string	一级 Quota 昵称。	os_MyQuota_p
type	string	Quota 类型，	FUXI_ONLINE
status	string	资源状态。	ON
tenantId	string	租户 ID。	478403690625249
regionId	string	区域 ID。	cn-beijing
cluster	string	集群 ID。	AT-120N
version	string	版本号。	1964
parameter	object	一级 quota 的 CU 值参数。	{ "enablePriority": false, "minCU": 25, "adhocCU": 0, "elasticReservedCU": 0, "forceReservedMin": false, "maxCU": 50, "schedulerType": "Fifo" }
createTime	integer	创建时间。	1719886322347
creatorId	string	创建者云账号 UID。	672863518
isEffective	boolean	是否生效。	true/false

Examples

Success response

JSON format

{
  "requestId": "688003E1-D1B4-5468-957E-2FFB3AC8D79B",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "name": "planA",
    "createTime": "1714356241163",
    "quota": {
      "subQuotaInfoList": [
        {
          "id": "10940",
          "name": "dp_cn_shanghai_1696659792_p",
          "nickName": "os_MyQuota",
          "type": "FUXI_ONLINE",
          "status": "ON",
          "tenantId": "478403690625249",
          "regionId": "cn-beijing",
          "cluster": "AT-120N\n",
          "version": "1386",
          "parameter": {
            "enablePriority": false,
            "minCU": 25,
            "adhocCU": 0,
            "elasticReservedCU": 0,
            "forceReservedMin": false,
            "maxCU": 50,
            "schedulerType": "Fifo"
          },
          "createTime": 1718155201628,
          "creatorId": "672863518"
        }
      ],
      "id": "2413",
      "name": "dp_cn_shanghai_1699533470_p",
      "nickName": "os_MyQuota_p",
      "type": "FUXI_ONLINE",
      "status": "ON",
      "tenantId": "478403690625249",
      "regionId": "cn-beijing",
      "cluster": "AT-120N\n",
      "version": "1964",
      "parameter": {
        "enablePriority": false,
        "minCU": 25,
        "adhocCU": 0,
        "elasticReservedCU": 0,
        "forceReservedMin": false,
        "maxCU": 50,
        "schedulerType": "Fifo"
      },
      "createTime": 1719886322347,
      "creatorId": "672863518"
    },
    "isEffective": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.