ListQuotas

Updated at:

Retrieves a list of quotas.

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

get

*Quota

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

None None

Request syntax

GET /api/v1/quotas HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

tenantId deprecated

string

No

region deprecated

string

No

productId deprecated

string

No

billingType

string

No

The billing method.

subscription

saleTags

string

No

Filters quotas by billing tags. Billing tags are created by users for cloud products.

{"tag":"this_is_tag_demo"}

marker

string

No

Specifies the marker after which results are returned in alphabetical order.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==

maxItem

integer

No

The maximum number of items to return.

100

Response elements

Element

Type

Description

Example

object

PopCompatibleResult

requestId

string

The request ID.

0bc12e6f16677875480593081d2956

quotaInfoList

array<object>

The list of quotas.

array<object>

The list of quotas.

billingPolicy

object

The billing information.

billingMethod

string

The billing method. Valid values:

  • subscription: indicates a subscription quota.

  • payasyougo: indicates a pay-as-you-go quota.

subscription

odpsSpecCode

string

The order specification.

OdpsStandard

orderId

string

The order ID.

45245678

saleTag

object

The identifier of the MaxCompute quota object. This identifier is consistent with the identifier in Alibaba Cloud billing and is used in tagging scenarios.

resourceIds

array

The identifier of the MaxCompute quota object. This identifier also exists in the Alibaba Cloud billing subsystem. You can use this identifier to associate all fees of the quota object with a specific tag.

string

The identifier of the MaxCompute quota object.

"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"

resourceType

string

The object type. Only quota and project are supported.

"project"

cluster

string

The cluster ID.

AT-120N

createTime

integer

The time when the resource was created. The time is in ISO 8601 format in the UTC time zone.

2022-09-06T02:14:44Z

creatorId

string

The ID of the Alibaba Cloud account that created the resource.

672863518

id

string

quota ID

0

name

string

The quota name.

quota_a

nickName

string

The alias of the quota.

quota_nickname

parameter

object

The description of the quota.

{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }

parentId

string

The ID of the parent resource.

null

regionId

string

The region ID.

cn-beijing

scheduleInfo

object

The time-based scheduling information.

currPlan

string

The quota plan that takes effect according to the schedule.

planA

currTime

string

The time when the current plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

0800

nextPlan

string

The quota plan that will take effect according to the schedule.

planB

nextTime

string

The time when the next plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

1700

oncePlan

string

The quota plan that takes effect immediately. This parameter is not empty if the user triggers the immediate effect and the plan is different from the current plan.

planC

onceTime

string

The time when the immediate effect is triggered. The time is in HHmm format. For example, 0800 indicates 08:00.

1500

operatorName

string

The name of the operator.

userA

timezone

string

The time zone.

UTC+8

status

string

The resource status.

ON

subQuotaInfoList

array<object>

The level-2 quota information.

array<object>

The level-2 quota information.

saleTag

object

The identifier of the MaxCompute quota object. This identifier is consistent with the identifier in Alibaba Cloud billing and is used in tagging scenarios.

resourceIds

array

The identifier of the MaxCompute quota object. This identifier also exists in the Alibaba Cloud billing subsystem. You can use this identifier to associate all fees of the quota object with a specific tag.

string

The identifier of the MaxCompute quota object.

"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"

resourceType

string

The object type. Only quota and project are supported.

"quota"

billingPolicy

object

The billing information.

billingMethod

string

The billing method. Valid values:

  • subscription: indicates a subscription quota.

  • payasyougo: indicates a pay-as-you-go quota.

subscription

odpsSpecCode

string

The order specification.

OdpsStandard

orderId

string

The order ID.

45245678

cluster

string

The cluster ID.

AT-120N

createTime

integer

The time when the resource was created. The time is in ISO 8601 format in the UTC time zone.

2022-09-06T02:14:44Z

creatorId

string

The ID of the Alibaba Cloud account that created the resource.

672863518

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

parameter

object

The description of the quota.

{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }

enablePriority

boolean

Specifies whether priority is enabled.

true

forceReservedMin

boolean

Specifies whether the resources are exclusive.

true

maxCU

integer

The upper limit of reserved CUs.

50

minCU

integer

The minimum guaranteed reserved CUs.

50

schedulerType

string

The scheduling policy.

Fifo/Fair

singleJobCULimit

integer

The CU limit for a single job.

10

elasticReservedCU

integer

The number of elastic reserved CUs.

50

slotNum

integer

0

adhocSlot

integer

0

minGu

integer

0

maxGu

integer

0

autoScaleCPULimit

integer

The upper limit of CPUs for automatic scaling.

0

parentId

string

The ID of the parent resource.

0

regionId

string

The region ID.

cn-beijing

scheduleInfo

object

The time-based scheduling information.

currPlan

string

The quota plan that takes effect according to the schedule.

planA

currTime

string

The time when the current plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

0800

nextPlan

string

The quota plan that will take effect according to the schedule.

planB

nextTime

string

The time when the next plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

1700

oncePlan

string

The quota plan that takes effect immediately. This parameter is not empty if the user triggers the immediate effect and the plan is different from the current plan.

planC

onceTime

string

The time when the immediate effect is triggered. The time is in HHmm format. For example, 0800 indicates 08:00.

1500

operatorName

string

The name of the operator.

userA

timezone

string

The time zone.

UTC+8

status

string

The resource status.

ON

tag

string

The resource tag of the quota.

abc

tenantId

string

The tenant ID.

280747109771520

type

string

The resourceSystemType field of the control cluster.

FUXI_ONLINE

version

string

The version.

1

tag

string

The resource tag of the quota.

abc

tenantId

string

The tenant ID.

280747109771520

type

string

The resourceSystemType field of the control cluster.

FUXI_ONLINE

version

string

The version.

1

Tags

array<object>

The tags.

object

The tags.

TagValue

string

The tag value.

1

TagKey

string

The tag key.

Department

marker

string

Specifies the marker after which results are returned in alphabetical order.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==

maxItem

integer

The maximum number of results returned per page.

10

data

object

The returned data.

quotaInfoList

array<object>

The list of quotas.

array<object>

The list of quotas.

id

string

quota id

0

name

string

The quota name.

quota_a

nickName

string

The alias of the quota.

quota_nickname

type

string

The resourceSystemType field of the control cluster.

FUXI_ONLINE

status

string

The resource status.

ON

tenantId

string

The tenant ID.

280747109771520

regionId

string

The region ID.

cn-beijing

parentId

string

The ID of the parent resource.

null

cluster

string

The cluster ID.

AT-120N

version

string

The version.

1

billingPolicy

object

The billing information.

odpsSpecCode

string

The order specification.

OdpsStandard

orderId

string

The order ID.

45245678

billingMethod

string

The billing method. Valid values:

  • subscription: indicates a subscription quota.

  • payasyougo: indicates a pay-as-you-go quota.

subscription

scheduleInfo

object

The schedule information.

currPlan

string

The quota plan that takes effect according to the schedule.

planA

currTime

string

The time when the current plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

0800

nextPlan

string

The quota plan that will take effect according to the schedule.

planB

nextTime

string

The time when the next plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

1700

oncePlan

string

The quota plan that takes effect immediately. This parameter is not empty if the user triggers the immediate effect and the plan is different from the current plan.

planC

onceTime

string

The time when the immediate effect is triggered. The time is in HHmm format. For example, 0800 indicates 08:00.

1500

operatorName

string

The name of the operator.

userA

timezone

string

The time zone.

UTC+8

parameter

object

The description of the quota.

{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }

tag

string

The resource tag of the quota.

abc

createTime

integer

The time when the resource was created. The time is in ISO 8601 format in the UTC time zone.

2022-09-06T02:14:44Z

creatorId

string

The ID of the Alibaba Cloud account that created the resource.

672863518

saleTag

object

The identifier of the MaxCompute quota object. This identifier is consistent with the identifier in Alibaba Cloud billing and is used in tagging scenarios.

resourceIds

array

The identifier of the MaxCompute quota object. This identifier also exists in the Alibaba Cloud billing subsystem. You can use this identifier to associate all fees of the quota object with a specific tag.

string

The identifier of the MaxCompute quota object.

"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"

resourceType

string

The object type. Only quota and project are supported.

"quota"

subQuotaInfoList

array<object>

The level-2 quota information.

array<object>

The level-2 quota information.

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

The resourceSystemType field of the control cluster.

FUXI_ONLINE

status

string

The resource status.

ON

tenantId

string

The tenant ID.

280747109771520

regionId

string

The region ID.

cn-beijing

parentId

string

The ID of the parent resource.

0

cluster

string

The cluster ID.

AT-120N

version

string

The version number.

1

billingPolicy

object

The billing information.

odpsSpecCode

string

The order specification.

OdpsStandard

orderId

string

The order ID.

45245678

billingMethod

string

The billing method. Valid values:

  • subscription: Indicates a subscription quota.

  • payasyougo: Indicates a pay-as-you-go quota.

subscription

scheduleInfo

object

The schedule information.

currPlan

string

The quota plan that takes effect according to the schedule.

planA

currTime

string

The time when the current plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

0800

nextPlan

string

The quota plan that will take effect according to the schedule.

planB

nextTime

string

The time when the next plan is scheduled. The time is in HHmm format. For example, 0800 indicates 08:00.

1700

oncePlan

string

The quota plan that takes effect immediately. This parameter is not empty if the user triggers the immediate effect and the plan is different from the current plan.

planC

onceTime

string

The time when the immediate effect is triggered. The time is in HHmm format. For example, 0800 indicates 08:00.

1500

operatorName

string

The name of the operator.

userA

timezone

string

The time zone.

UTC+8

parameter

object

The description of the quota.

{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }

enablePriority

boolean

Specifies whether priority is enabled.

true

forceReservedMin

boolean

Specifies whether the resources are exclusive.

true

maxCU

integer

The upper limit of reserved CUs.

50

minCU

integer

The minimum guaranteed reserved CUs.

50

schedulerType

string

The scheduling policy.

Fifo/Fair

singleJobCULimit

integer

The CU limit for a single job.

10

elasticReservedCU

integer

The number of elastic reserved CUs.

50

slotNum

integer

0

adhocSlot

integer

0

autoScaleCPULimit

integer

The upper limit of CPUs for automatic scaling.

0

minGu

integer

0

maxGu

integer

0

tag

string

The resource tag of the quota.

abc

createTime

integer

The time when the resource was created. The time is in ISO 8601 format in the UTC time zone.

2022-09-06T02:14:44Z

creatorId

string

The ID of the Alibaba Cloud account that created the resource.

672863518

saleTag

object

The identifier of the MaxCompute quota object. This identifier is consistent with the identifier in Alibaba Cloud billing and is used in tagging scenarios.

resourceIds

array

The identifier of the MaxCompute quota object. This identifier also exists in the Alibaba Cloud billing subsystem. You can use this identifier to associate all fees of the quota object with a specific tag.

string

The identifier of the MaxCompute quota object.

"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd"

resourceType

string

The object type. Only quota and project are supported.

"quota"

Tags

array<object>

The tags.

object

The tags.

TagValue

string

The tag value.

a12351qHDP6YEQMt

TagKey

string

The tag key.

Department

marker

string

Specifies the marker after which results are returned in alphabetical order.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==

maxItem

integer

The maximum number of results returned per page.

10

NextToken

string

The pagination token. This operation supports only sequential pagination. A non-empty NextToken value indicates that more data is available. Specify this token in the next request to retrieve the next page.

"abcde"

NextToken

string

The pagination token. This operation supports only sequential pagination. A non-empty NextToken value indicates that more data is available. Specify this token in the next request to retrieve the next page.

AAAAAdDWBF2w6Olxc+cMPjUtUMo/CvPe4IK7f7kIQFrIZjyc

Examples

Success response

JSON format

{
  "requestId": "0bc12e6f16677875480593081d2956",
  "quotaInfoList": [
    {
      "billingPolicy": {
        "billingMethod": "subscription",
        "odpsSpecCode": "OdpsStandard ",
        "orderId": "45245678"
      },
      "saleTag": {
        "resourceIds": [
          "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\""
        ],
        "resourceType": "\"project\""
      },
      "cluster": "AT-120N\n",
      "createTime": 0,
      "creatorId": "672863518\n",
      "id": "0",
      "name": "quota_a\n",
      "nickName": "quota_nickname\n",
      "parameter": {
        "test": "test",
        "test2": 1
      },
      "parentId": "null",
      "regionId": "cn-beijing",
      "scheduleInfo": {
        "currPlan": "planA",
        "currTime": "0800",
        "nextPlan": "planB",
        "nextTime": "1700",
        "oncePlan": "planC",
        "onceTime": "1500",
        "operatorName": "userA",
        "timezone": "UTC+8"
      },
      "status": "ON \n",
      "subQuotaInfoList": [
        {
          "saleTag": {
            "resourceIds": [
              "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
            ],
            "resourceType": "\"quota\""
          },
          "billingPolicy": {
            "billingMethod": "subscription\n",
            "odpsSpecCode": "OdpsStandard ",
            "orderId": "45245678\n"
          },
          "cluster": "AT-120N",
          "createTime": 0,
          "creatorId": "672863518\n",
          "id": "1000048",
          "name": "subquotaA\n",
          "nickName": "subquotaA\n",
          "parameter": {
            "enablePriority": true,
            "forceReservedMin": true,
            "maxCU": 50,
            "minCU": 50,
            "schedulerType": "Fifo/Fair\n",
            "singleJobCULimit": 10,
            "elasticReservedCU": 50,
            "slotNum": 0,
            "adhocSlot": 0,
            "minGu": 0,
            "maxGu": 0,
            "autoScaleCPULimit": 0
          },
          "parentId": "0",
          "regionId": "cn-beijing",
          "scheduleInfo": {
            "currPlan": "planA",
            "currTime": "0800",
            "nextPlan": "planB",
            "nextTime": "1700",
            "oncePlan": "planC",
            "onceTime": "1500",
            "operatorName": "userA",
            "timezone": "UTC+8"
          },
          "status": "ON",
          "tag": "abc",
          "tenantId": "280747109771520\n",
          "type": "FUXI_ONLINE\n",
          "version": "1"
        }
      ],
      "tag": "abc",
      "tenantId": "280747109771520\n",
      "type": "FUXI_ONLINE\n",
      "version": "1",
      "Tags": [
        {
          "TagValue": "1",
          "TagKey": "Department"
        }
      ]
    }
  ],
  "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
  "maxItem": 10,
  "data": {
    "quotaInfoList": [
      {
        "id": "0\n",
        "name": "quota_a\n",
        "nickName": "quota_nickname",
        "type": "FUXI_ONLINE",
        "status": "ON",
        "tenantId": "280747109771520",
        "regionId": "cn-beijing",
        "parentId": "null",
        "cluster": "AT-120N",
        "version": "1",
        "billingPolicy": {
          "odpsSpecCode": "OdpsStandard ",
          "orderId": "45245678\n",
          "billingMethod": "subscription"
        },
        "scheduleInfo": {
          "currPlan": "planA\n",
          "currTime": "0800",
          "nextPlan": "planB",
          "nextTime": "1700",
          "oncePlan": "planC",
          "onceTime": "1500",
          "operatorName": "userA",
          "timezone": "UTC+8"
        },
        "parameter": {
          "test": "test",
          "test2": 1
        },
        "tag": "abc",
        "createTime": 0,
        "creatorId": "672863518\n",
        "saleTag": {
          "resourceIds": [
            "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
          ],
          "resourceType": "\"quota\"\n"
        },
        "subQuotaInfoList": [
          {
            "id": "1000048",
            "name": "subquotaA\n",
            "nickName": "subquotaA\n",
            "type": "FUXI_ONLINE\n",
            "status": "ON",
            "tenantId": "280747109771520\n",
            "regionId": "cn-beijing",
            "parentId": "0",
            "cluster": "AT-120N",
            "version": "1",
            "billingPolicy": {
              "odpsSpecCode": "OdpsStandard ",
              "orderId": "45245678\n",
              "billingMethod": "subscription"
            },
            "scheduleInfo": {
              "currPlan": "planA",
              "currTime": "0800",
              "nextPlan": "planB",
              "nextTime": "1700",
              "oncePlan": "planC",
              "onceTime": "1500",
              "operatorName": "userA",
              "timezone": "UTC+8"
            },
            "parameter": {
              "enablePriority": true,
              "forceReservedMin": true,
              "maxCU": 50,
              "minCU": 50,
              "schedulerType": "Fifo/Fair\n",
              "singleJobCULimit": 10,
              "elasticReservedCU": 50,
              "slotNum": 0,
              "adhocSlot": 0,
              "autoScaleCPULimit": 0,
              "minGu": 0,
              "maxGu": 0
            },
            "tag": "abc",
            "createTime": 0,
            "creatorId": "672863518\n",
            "saleTag": {
              "resourceIds": [
                "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
              ],
              "resourceType": "\"quota\"\n"
            }
          }
        ],
        "Tags": [
          {
            "TagValue": "a12351qHDP6YEQMt",
            "TagKey": "Department"
          }
        ]
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "\"abcde\""
  },
  "NextToken": "AAAAAdDWBF2w6Olxc+cMPjUtUMo/CvPe4IK7f7kIQFrIZjyc"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.