GetQuota - MaxCompute - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/v1/quotas/{nickname}

Request parameters

Parameter	Type	Required	Description	Example
nickname	string	Yes	The name of the quota.	quota_a
tenantId	string	No	The tenant ID.	520539530998273
region	string	No	The region ID.	cn-chengdu
AkProven	string	No	The trusted AccessKey pairs.	null
mock	boolean	No	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

Parameter	Type	Description	Example
	object	The returned result.
billingPolicy	object	The information about the order.
billingMethod	string	The billing method of the quota. Valid values: subscription: a subscription quota. payasyougo: a pay-as-you-go quota.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
saleTag	object	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.
resourceIds	array	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. 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"
resourceType	string	The type of the object. Valid values: quota and project.	"quota"
cluster	string	The cluster ID.	AT-120N
createTime	long	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the Alibaba Cloud account that is used to create the resource.	672863518
requestId	string	The request ID.	0b87b7a316654730544735643e9200
id	string	The quota ID.	0
name	string	The name of the quota.	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 information about 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	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
onceTime	string	The time when the quota plan immediately takes effect.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone of the project.	UTC+8
status	string	The status of the resource.	ON
subQuotaInfoList	object []	The information about the level-2 quota.
billingPolicy	object	The information about the order.
billingMethod	string	The billing method of the quota. Valid values: subscription: a subscription quota. payasyougo: a pay-as-you-go quota.	subscription
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	45245678
saleTag	object	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.
resourceIds	array	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. 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"
resourceType	string	The type of the object. Valid values: quota and project.	"quota"
cluster	string	The cluster ID.	AT-120N
createTime	long	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	The ID of the Alibaba Cloud account that is used to create 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", }
parentId	string	The ID of the parent resource.	0
regionId	string	The region ID.	cn-beijing
scheduleInfo	object	The information about 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	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
onceTime	string	The time when the quota plan immediately takes effect.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone of the project.	UTC+8
status	string	The status of the resource.	ON
tag	string	The tag of the resource for the quota.	abc
tenantId	string	The tenant ID.	478403690625249
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.	FUXI_ONLINE
version	string	The version number.	1
tag	string	The tag of the resource for the quota.	abc
tenantId	string	The tenant ID.	478403690625249
type	string	The type of the resource system. This parameter corresponds to the resourceSystemType parameter of the cluster.	FUXI_ONLINE
version	string	The version number.	1
data	object	The returned data.
id	string	The quota ID.	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
saleTag	object	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.
resourceIds	array	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. 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"
resourceType	string	The type of the object. Valid values: quota and project.	"quota"
tenantId	string	The tenant ID.	478403690625249
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 number.	1
billingPolicy	object	The information about the order.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	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 about 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	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
onceTime	string	The time when the quota plan immediately takes effect.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone of the project.	UTC+8
parameter	object	The description of the quota.	{"minCU":10, "adhocCU":0, "maxCU":10, "schedulerType":"Fair", }
tag	string	The tag of the resource for the quota.	abc
createTime	long	The time when the resource 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	object []	The information about the level-2 quota.
id	string	The ID of the level-2 quota.	1000048
name	string	The name of the level-2 quota.	subquotaA
saleTag	object	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.
resourceIds	array	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. 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"
resourceType	string	The type of the object. Valid values: quota and project.	"quota"
nickName	string	The nickname 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 tenant ID.	478403690625249
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 information about the order.
odpsSpecCode	string	The specifications of the order.	OdpsStandard
orderId	string	The order ID.	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 about 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	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
onceTime	string	The time when the quota plan immediately takes effect.	1500
operatorName	string	The name of the operator.	userA
timezone	string	The time zone of the project.	UTC+8
parameter	object	The description of the quota.
tag	string	The tag of the resource for the quota.	abc
createTime	long	The time when the resource was created.	2022-09-06T02:14:44Z
creatorId	string	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 time

Summary of changes

Operation

2023-09-21

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-08-22

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2022-04-14

Add Operation

see changesets