All Products
Search
Document Center

MaxCompute:GetQuota

Last Updated:Sep 23, 2024

Obtains the information about a specified level-1 quota.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
nicknamestringYes

The name of the quota.

quota_a
tenantIdstringNo

The tenant ID.

520539530998273
regionstringNo

The region ID.

cn-chengdu
AkProvenstringNo

The trusted AccessKey pairs.

null
mockbooleanNo

Specifies whether to include submodules. Valid values: -true: The request includes submodules. -false: The request does not include submodules. This is the default value.

false

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

billingPolicyobject

The information about 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.

resourceIdstring

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.

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

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

"quota"
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
requestIdstring

The request ID.

0b87b7a316654730544735643e9200
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 about 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 resource.

ON
subQuotaInfoListarray<object>

The information about the level-2 quota.

subQuotaInfoListobject
billingPolicyobject

The information about 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.

resourceIdstring

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.

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

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

"quota"
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 about 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 resource.

ON
tagstring

The tag of the resource for the quota.

abc
tenantIdstring

The tenant ID.

478403690625249
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.

478403690625249
typestring

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

FUXI_ONLINE
versionstring

The version number.

1
dataobject

The returned data.

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 resource.

ON
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.

resourceIdstring

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.

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

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

"quota"
tenantIdstring

The tenant ID.

478403690625249
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 about 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 about 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
subQuotaInfoListarray<object>

The information about the level-2 quota.

subQuotaInfoListobject
idstring

The ID of the level-2 quota.

1000048
namestring

The name of the level-2 quota.

subquotaA
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.

resourceIdstring

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.

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

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

"quota"
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 resource.

ON
tenantIdstring

The tenant ID.

478403690625249
regionIdstring

The region ID.

cn-beijing
parentIdstring

The ID of the parent resource.

0
clusterstring

The cluster ID.

AT-120N
versionstring

The version number.

1
billingPolicyobject

The information about 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 about 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.

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

Examples

Sample success responses

JSONformat

{
  "billingPolicy": {
    "billingMethod": "subscription\n",
    "odpsSpecCode": "OdpsStandard",
    "orderId": "45245678"
  },
  "saleTag": {
    "resourceIds": [
      "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
    ],
    "resourceType": "\"quota\""
  },
  "cluster": "AT-120N",
  "createTime": 0,
  "creatorId": "672863518\n",
  "requestId": "0b87b7a316654730544735643e9200",
  "id": "0",
  "name": "quota_a\n",
  "nickName": "quota_nickname",
  "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",
  "subQuotaInfoList": [
    {
      "billingPolicy": {
        "billingMethod": "subscription",
        "odpsSpecCode": "OdpsStandard\n",
        "orderId": "45245678\n"
      },
      "saleTag": {
        "resourceIds": [
          "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
        ],
        "resourceType": "\"quota\""
      },
      "cluster": "AT-120N\n",
      "createTime": 0,
      "creatorId": "672863518\n",
      "id": "1000048\n",
      "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\n",
        "timezone": "UTC+8"
      },
      "status": "ON\n",
      "tag": "abc",
      "tenantId": "478403690625249",
      "type": "FUXI_ONLINE",
      "version": "1"
    }
  ],
  "tag": "abc",
  "tenantId": "478403690625249",
  "type": "FUXI_ONLINE",
  "version": "1",
  "data": {
    "id": "0",
    "name": "quota_a",
    "nickName": "quota_nickname",
    "type": "FUXI_ONLINE",
    "status": "ON",
    "saleTag": {
      "resourceIds": [
        "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
      ],
      "resourceType": "\"quota\"\n"
    },
    "tenantId": "478403690625249",
    "regionId": "cn-beijing",
    "parentId": "null",
    "cluster": "AT-120N",
    "version": "1",
    "billingPolicy": {
      "odpsSpecCode": "OdpsStandard",
      "orderId": "45245678",
      "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",
    "subQuotaInfoList": [
      {
        "id": "1000048",
        "name": "subquotaA",
        "saleTag": {
          "resourceIds": [
            "\"aaaaaaa-bbbb-4fd0-a8eb-50861590f7dd\"\n"
          ],
          "resourceType": "\"quota\"\n"
        },
        "nickName": "subquotaA",
        "type": "FUXI_ONLINE",
        "status": "ON",
        "tenantId": "478403690625249\n",
        "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",
          "timezone": "UTC+8"
        },
        "parameter": {
          "test": "test",
          "test2": 1
        },
        "tag": "abc",
        "createTime": 0,
        "creatorId": "672863518"
      }
    ]
  }
}

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 changedView Change Details
2023-08-22The response structure of the API has changedView Change Details
2022-04-14Add OperationView Change Details