Use GetQuotaPlan to obtain quota plan information - 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:GetQuotaPlan

get

*Quota

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	Quota 名称	quotaA
planName	string	Yes	Quota 计划名称	planA

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	租户 id。	483212237127906
region	string	No	地域 id。	cn-beijing

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	请求 id。	0be3e0aa16667684362147582e038f
data	object	返回数据。
name	string	quota 计划名称	planA
createTime	string	创建时间。	2022-05-16T06:07:45Z
quota	object	quota 详情
id	string	quota ID	0
name	string	quota 名称	quota_a
nickName	string	quota 别名	quota_nickname
type	string	对应控制集群的 resourceSystemType 字段	FUXI_ONLINE
status	string	资源状态	ON
tenantId	string	租户 id。	478403690625249
regionId	string	地域 id。	cn-beijing
parentId	string	父资源 id。	null
cluster	string	集群 id。	AT-120N
version	string	版本号。	1
billingPolicy	object	订单信息
odpsSpecCode	string	订单规格	OdpsStandard
orderId	string	订单号。	45245678
billingMethod	string	付费模式。 subscription,表示是预付费 quota。 payasyougo，表示是后付费 quota。	subscription
scheduleInfo	object	分时信息
currPlan	string	按照调度计划生效的 quota 计划	planA
currTime	string	currPlan 被调度的时间	0800
nextPlan	string	按照调度计划将要生效的 quota plan	planB
nextTime	string	next_plan 被调度的时间	1700
oncePlan	string	如果用户触发了立即生效且不同于 curr_plan，那么非空。	planC
onceTime	string	立即生效触发的时间	1500
operatorName	string	操作者名称。	userA
parameter	object	quota 的描述信息
tag	string	quota 的资源标签	abc
createTime	integer	创建时间。	2022-09-06T02:14:44Z
creatorId	string	资源创建者，云账号 UID。	672863518
subQuotaInfoList	array<object>	二级 quota 信息
	array<object>	二级 quota 信息
id	string	二级 quota ID	1000048
name	string	二级 quota 名称	subquotaA
nickName	string	二级 quota 别名	subquotaA
type	string	对应控制集群的 resourceSystemType 字段	FUXI_ONLINE
status	string	资源状态	ON
tenantId	string	租户 id。	478403690625249
regionId	string	地域 id。	cn-beijing
parentId	string	父资源 id。	0
cluster	string	集群 id	AT-120N
version	string	版本号	1
billingPolicy	object	订单信息
odpsSpecCode	string	订单规格	OdpsStandard
orderId	string	订单 id。	45245678
billingMethod	string	付费模式。 subscription,表示是预付费 quota。 payasyougo，表示是后付费 quota。	subscription
scheduleInfo	object	分时信息。
currPlan	string	按照调度计划生效的 quota 计划	planA
currTime	string	currPlan 被调度的时间	0800
nextPlan	string	计划将要生效的 quota 计划	planB
nextTime	string	next_plan 被调度的时间	1700
oncePlan	string	如果用户触发了立即生效且不同于 curr_plan，那么非空。	planC
onceTime	string	立即生效触发的时间	1500
operatorName	string	操作者名称。	userA
parameter	object	quota 的描述信息
tag	string	quota 的资源标签	abc
createTime	integer	资源创建时间	2022-09-06T02:14:44Z
creatorId	string	创建者 id。	672863518

Examples

Success response

JSON format

{
  "requestId": "0be3e0aa16667684362147582e038f",
  "data": {
    "name": "planA",
    "createTime": "2022-05-16T06:07:45Z",
    "quota": {
      "id": "0",
      "name": "quota_a\n",
      "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",
        "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"
          },
          "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.