GetQuotaPlan-阿里云帮助中心

Obtains the information of a 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}/plans/{planName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	The name of the quota.	quotaA
planName	string	Yes	The name of the quota plan.	planA

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The ID of the tenant.	483212237127906
region	string	No	The ID of the region.	cn-beijing

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	The ID of the request.	0be3e0aa16667684362147582e038f
data	object	The returned data.
name	string	The name of the quota plan.	planA
createTime	string	The time when the quota plan was created.	2022-05-16T06:07:45Z
quota	object	The details of the quota.
id	string	The ID of the quota.	0
name	string	The name of the quota.	quota_a
nickName	string	The alias of the quota.	quota_nickname
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.	FUXI_ONLINE
status	string	The status of the resource.	ON
tenantId	string	The ID of the tenant.	478403690625249
regionId	string	The ID of the region.	cn-beijing
parentId	string	The ID of the parent resource.	null
cluster	string	The ID of the cluster.	AT-120N
version	string	The version number.	1
billingPolicy	object	The information of the order.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The ID of the order.	45245678
billingMethod	string	The billing method of the quota. Valid values: subscription: a subscription quota. payasyougo: a pay-as-you-go quota.	subscription
scheduleInfo	object	The information of the scheduling plan.
currPlan	string	The quota plan that takes effect based on the scheduling plan.	planA
currTime	string	The time when the current quota plan is scheduled.	0800
nextPlan	string	The next quota plan that will take effect based on the scheduling plan.	planB
nextTime	string	The time when the next quota plan is scheduled.	1700
oncePlan	string	If the quota plan that immediately takes effect is different from the current quota plan, this parameter is not empty.	planC
onceTime	string	The time when the quota plan immediately takes effect.	1500
operatorName	string	The name of the operator.	userA
parameter	object	The description of the quota.
tag	string	The tag of the resource for the quota.	abc
createTime	integer	The time when the quota plan was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the Alibaba Cloud account that is used to create the resource.	672863518
subQuotaInfoList	array<object>	The information of the level-2 quota.
	array<object>	The information of the level-2 quota.
id	string	The ID of the level-2 quota.	1000048
name	string	The name of the level-2 quota.	subquotaA
nickName	string	The alias of the level-2 quota.	subquotaA
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.	FUXI_ONLINE
status	string	The status of the resource.	ON
tenantId	string	The ID of the tenant.	478403690625249
regionId	string	The ID of the region.	cn-beijing
parentId	string	The ID of the parent resource.	0
cluster	string	The ID of the cluster.	AT-120N
version	string	The version number.	1
billingPolicy	object	The information of the order.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The ID of the order.	45245678
billingMethod	string	The billing method of the quota. Valid values: subscription: a subscription quota. payasyougo: a pay-as-you-go quota.	subscription
scheduleInfo	object	The information of the scheduling plan.
currPlan	string	The quota plan that takes effect based on the scheduling plan.	planA
currTime	string	The time when the current quota plan is scheduled.	0800
nextPlan	string	The next quota plan that will take effect based on the scheduling plan.	planB
nextTime	string	The time when the next quota plan is scheduled.	1700
oncePlan	string	If the quota plan that immediately takes effect is different from the current quota plan, this parameter is not empty.	planC
onceTime	string	The time when the quota plan immediately takes effect.	1500
operatorName	string	The name of the operator.	userA
parameter	object	The description of the quota.
tag	string	The tag of the resource for the quota.	abc
createTime	integer	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the user who created the quota plan.	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.