All Products
Search
Document Center

MaxCompute:ListQuotas

Last Updated:Jan 12, 2024

Queries quotas.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/v1/quotas

Request parameters

ParameterTypeRequiredDescriptionExample
tenantIdstringNo

The ID of the tenant.

280747109771520
regionstringNo

The ID of the region.

cn-beijing
productIdstringNo

The service ID.

ODPS
billingTypestringNo

The billing method of the quota.

subscription
saleTagsstringNo

The cost tag. You can filter out quota objects based on the cost tag. The cost tag is created when you tag a service.

{"tag":"this_is_tag_demo"}
markerstringNo

Specifies the marker after which the returned list begins.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemlongNo

The maximum number of entries to return on each page.

100

Response parameters

ParameterTypeDescriptionExample
object

PopCompatibleResult

requestIdstring

The ID of the request.

0bc12e6f16677875480593081d2956
quotaInfoListobject []

The list of quotas.

billingPolicyobject

The information of the order.

billingMethodstring

The billing method of the quota. Valid values:

  • subscription: a subscription quota.
  • payasyougo: a pay-as-you-go quota.
subscription
odpsSpecCodestring

The specifications of the order.

OdpsStandard
orderIdstring

The order ID.

45245678
saleTagobject

The identifier of an object in a MaxCompute quota. This identifier is the same as the identifier in the sales bill of Alibaba Cloud. This parameter is used for tags.

resourceIdsarray

The identifier of an object in a MaxCompute quota. This identifier exists in the sales bill of Alibaba Cloud. You can use this identifier to associate the cost of a quota object with a tag.

string

The identifier of an object in a MaxCompute quota.

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

The type of the object. Valid values: quota and project.

"project"
clusterstring

The cluster ID.

AT-120N
createTimelong

The time when the resource was created.

2022-09-06T02:14:44Z
creatorIdstring

The ID of the Alibaba Cloud account that is used to create the resource.

672863518
idstring

The quota ID.

0
namestring

The name of the quota.

quota_a
nickNamestring

The alias of the quota.

quota_nickname
parameterobject

The description of the quota.

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

The ID of the parent resource.

null
regionIdstring

The region ID.

cn-beijing
scheduleInfoobject

The information of the scheduling plan.

currPlanstring

The quota plan that takes effect based on the scheduling plan.

planA
currTimestring

The time when the current quota plan is scheduled.

0800
nextPlanstring

The next quota plan that will take effect based on the scheduling plan.

planB
nextTimestring

The time when the next quota plan is scheduled.

1700
oncePlanstring

The quota plan that immediately takes effect. If the quota plan that immediately takes effect is different from the current quota plan, this parameter is not empty.

planC
onceTimestring

The time when the quota plan immediately takes effect.

1500
operatorNamestring

The name of the operator.

userA
timezonestring

The time zone of the project.

UTC+8
statusstring

The status of the endpoint group.

ON
subQuotaInfoListobject []

The information of the level-2 quota.

saleTagobject

The identifier of an object in a MaxCompute quota. This identifier is the same as the identifier in the sales bill of Alibaba Cloud. This parameter is used for tags.

resourceIdsarray

The identifier of an object in a MaxCompute quota. This identifier exists in the sales bill of Alibaba Cloud. You can use this identifier to associate the cost of a quota object with a tag.

string

The identifier of an object in a MaxCompute quota.

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

The type of the object. Valid values: quota and project.

"quota"
billingPolicyobject

The information of the order.

billingMethodstring

The billing method of the quota. Valid values:

  • subscription: a subscription quota.
  • payasyougo: a pay-as-you-go quota.
subscription
odpsSpecCodestring

The specifications of the order.

OdpsStandard
orderIdstring

The order ID.

45245678
clusterstring

The cluster ID.

AT-120N
createTimelong

The time when the resource was created.

2022-09-06T02:14:44Z
creatorIdstring

The ID of the Alibaba Cloud account that is used to create the resource.

672863518
idstring

The ID of the level-2 quota.

1000048
namestring

The name of the level-2 quota.

subquotaA
nickNamestring

The alias of the level-2 quota.

subquotaA
parameterobject

The description of the quota.

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

The ID of the parent resource.

0
regionIdstring

The region ID.

cn-beijing
scheduleInfoobject

The information of the scheduling plan.

currPlanstring

The quota plan that takes effect based on the scheduling plan.

planA
currTimestring

The time when the current quota plan is scheduled.

0800
nextPlanstring

The next quota plan that will take effect based on the scheduling plan.

planB
nextTimestring

The time when the next quota plan is scheduled.

1700
oncePlanstring

The quota plan that immediately takes effect. If the quota plan that immediately takes effect is different from the current quota plan, this parameter is not empty.

planC
onceTimestring

The time when the quota plan immediately takes effect.

1500
operatorNamestring

The name of the operator.

userA
timezonestring

The time zone of the project.

UTC+8
statusstring

The status of the endpoint group.

ON
tagstring

The tag of the resource for the quota.

abc
tenantIdstring

The tenant ID.

280747109771520
typestring

The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.

FUXI_ONLINE
versionstring

The version number.

1
tagstring

The tag of the resource for the quota.

abc
tenantIdstring

The tenant ID.

280747109771520
typestring

The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.

FUXI_ONLINE
versionstring

The version.

1
Tagsobject []

The tags.

TagValuestring

The value of the tag.

1
TagKeystring

The key of the tag.

Department
markerstring

Indicates the marker after which the returned list begins.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemlong

The maximum number of entries returned per page.

10
dataobject

The returned data.

quotaInfoListobject []

The list of quotas.

idstring

The quota ID.

0
namestring

The name of the quota.

quota_a
nickNamestring

The alias of the quota.

quota_nickname
typestring

The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.

FUXI_ONLINE
statusstring

The status of the endpoint group.

ON
tenantIdstring

The tenant ID.

280747109771520
regionIdstring

The region ID.

cn-beijing
parentIdstring

The ID of the parent resource.

null
clusterstring

The cluster ID.

AT-120N
versionstring

The version number.

1
billingPolicyobject

The information of the order.

odpsSpecCodestring

The specifications of the order.

OdpsStandard
orderIdstring

The order ID.

45245678
billingMethodstring

The billing method of the quota. Valid values:

  • subscription: a subscription quota.
  • payasyougo: a pay-as-you-go quota.
subscription
scheduleInfoobject

The information of the scheduling plan.

currPlanstring

The quota plan that takes effect based on the scheduling plan.

planA
currTimestring

The time when the current quota plan is scheduled.

0800
nextPlanstring

The next quota plan that will take effect based on the scheduling plan.

planB
nextTimestring

The time when the next quota plan is scheduled.

1700
oncePlanstring

The quota plan that immediately takes effect. If the quota plan that immediately takes effect is different from the current quota plan, this parameter is not empty.

planC
onceTimestring

The time when the quota plan immediately takes effect.

1500
operatorNamestring

The name of the operator.

userA
timezonestring

The time zone of the project.

UTC+8
parameterobject

The description of the quota.

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

The tag of the resource for the quota.

abc
createTimelong

The time when the resource was created.

2022-09-06T02:14:44Z
creatorIdstring

The ID of the Alibaba Cloud account that is used to create the resource.

672863518
saleTagobject

The identifier of an object in a MaxCompute quota. This identifier is the same as the identifier in the sales bill of Alibaba Cloud. This parameter is used for tags.

resourceIdsarray

The identifier of an object in a MaxCompute quota. This identifier exists in the sales bill of Alibaba Cloud. You can use this identifier to associate the cost of a quota object with a tag.

string

The identifier of an object in a MaxCompute quota.

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

The type of the object. Valid values: quota and project.

"quota"
subQuotaInfoListobject []

The information of the level-2 quota.

idstring

The ID of the level-2 quota.

1000048
namestring

The name of the level-2 quota.

subquotaA
nickNamestring

The nickname of the level-2 quota.

subquotaA
typestring

The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.

FUXI_ONLINE
statusstring

The status of the endpoint group.

ON
tenantIdstring

The tenant ID.

280747109771520
regionIdstring

The region ID.

cn-beijing
parentIdstring

The ID of the parent resource.

0
clusterstring

The cluster ID.

AT-120N
versionstring

The version of the algorithm image.

1
billingPolicyobject

The information of the order.

odpsSpecCodestring

The specifications of the order.

OdpsStandard
orderIdstring

The order ID.

45245678
billingMethodstring

The billing method of the quota. Valid values:

  • subscription: a subscription quota.
  • payasyougo: a pay-as-you-go quota.
subscription
scheduleInfoobject

The information of the scheduling plan.

currPlanstring

The quota plan that takes effect based on the scheduling plan.

planA
currTimestring

The time when the current quota plan is scheduled.

0800
nextPlanstring

The next quota plan that will take effect based on the scheduling plan.

planB
nextTimestring

The time when the next quota plan is scheduled.

1700
oncePlanstring

The quota plan that immediately takes effect. If the quota plan that immediately takes effect is different from the current quota plan, this parameter is not empty.

planC
onceTimestring

The time when the quota plan immediately takes effect.

1500
operatorNamestring

The name of the operator.

userA
timezonestring

The time zone of the project.

UTC+8
parameterobject

The description of the quota.

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

The tag of the resource for the quota.

abc
createTimelong

The time when the resource was created.

2022-09-06T02:14:44Z
creatorIdstring

The ID of the Alibaba Cloud account that is used to create the resource.

672863518
saleTagobject

The identifier of an object in a MaxCompute quota. This identifier is the same as the identifier in the sales bill of Alibaba Cloud. This parameter is used for tags.

resourceIdsarray

The identifier of an object in a MaxCompute quota. This identifier exists in the sales bill of Alibaba Cloud. You can use this identifier to associate the cost of a quota object with a tag.

string

The identifier of an object in a MaxCompute quota.

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

The type of the object. Valid values: quota and project.

"quota"
Tagsobject []

The tags.

TagValuestring

The value of the tag.

a12351qHDP6YEQMt
TagKeystring

The key of the tag.

Department
markerstring

Indicates the marker after which the returned list begins.

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemlong

The maximum number of entries returned per page.

10
NextTokenstring

A pagination token. Only continuous page turning is supported. If NextToken is not empty, the next page exists. The value of NextToken can be used in the next request to retrieve a new page of results.

"abcde"
NextTokenstring

A pagination token. Only continuous page turning is supported. If NextToken is not empty, the next page exists. The value of NextToken can be used in the next request to retrieve a new page of results.

AAAAAdDWBF2w6Olxc+cMPjUtUMo/CvPe4IK7f7kIQFrIZjyc

Examples

Sample success responses

JSONformat

{
  "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": {
            "test": "test",
            "test2": 1
          },
          "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": {
              "test": "test",
              "test2": 1
            },
            "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-22The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-04-14Add Operationsee changesets