文档

ListQuotas - 获取Quota列表

更新时间:

获取Quota列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/quotas

请求参数

名称类型必填描述示例值
tenantIdstring

租户 id

280747109771520
regionstring

地域 id

cn-beijing
productIdstring

产品 id

ODPS
billingTypestring

付费模式

subscription
saleTagsstring

可以根据费用标签来过滤 quota 对象,费用标签是用户在标签云产品创建的。

{"tag":"this_is_tag_demo"}
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemlong

限制返回的最大数。

100

返回参数

名称类型描述示例值
object

PopCompatibleResult

requestIdstring

请求 id。

0bc12e6f16677875480593081d2956
quotaInfoListobject []

quota 列表

billingPolicyobject

订单信息

billingMethodstring

付费模式。

  • subscription,表示是预付费 quota。
  • payasyougo,表示是后付费 quota。
subscription
odpsSpecCodestring

订单规格

OdpsStandard
orderIdstring

订单 id。

45245678
saleTagobject

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

resourceIdsarray

maxcompute quota 对象的标识,这个标识在阿里云售卖子系统内也存在。通过这个标识,可以把 quota 对象的费用都关联到某个标签上。

string

maxcompute quota 对象的标识

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

对象的类型,目前仅支持 quota 和 project 两种类型。

"project"
clusterstring

集群 id

AT-120N
createTimelong

资源创建时间

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

资源创建者,云账号 UID。

672863518
idstring

quota ID

0
namestring

quota 名称

quota_a
nickNamestring

quota 别名

quota_nickname
parameterobject

quota 的描述信息

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

父资源 id。

null
regionIdstring

地域 id。

cn-beijing
scheduleInfoobject

分时信息。

currPlanstring

按照调度计划生效的 quota 计划

planA
currTimestring

currPlan 被调度的时间

0800
nextPlanstring

按照调度计划将要生效的 quota 计划

planB
nextTimestring

next_plan 被调度的时间

1700
oncePlanstring

立即生效的 quota 计划。 如果用户触发了立即生效且不同于 curr_plan,那么非空。

planC
onceTimestring

立即生效触发的时间

1500
operatorNamestring

操作人名称。

userA
timezonestring

时区

UTC+8
statusstring

资源状态

ON
subQuotaInfoListobject []

二级 quota 信息

saleTagobject

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

resourceIdsarray

maxcompute quota 对象的标识,这个标识在阿里云售卖子系统内也存在。通过这个标识,可以把 quota 对象的费用都关联到某个标签上。

string

maxcompute quota 对象的标识

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

对象的类型,目前仅支持 quota 和 project 两种类型。

"quota"
billingPolicyobject

订单信息

billingMethodstring

付费模式。

  • subscription,表示是预付费 quota。
  • payasyougo,表示是后付费 quota。
subscription
odpsSpecCodestring

订单规格

OdpsStandard
orderIdstring

订单 id。

45245678
clusterstring

集群 id

AT-120N
createTimelong

资源创建时间

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

资源创建者,云账号 UID。

672863518
idstring

二级 quota ID

1000048
namestring

二级 quota 名称

subquotaA
nickNamestring

二级 quota 别名

subquotaA
parameterobject

quota 的描述信息

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

父资源 id

0
regionIdstring

地域 id。

cn-beijing
scheduleInfoobject

分时信息。

currPlanstring

按照调度计划生效的 quota 计划

planA
currTimestring

currPlan 被调度的时间

0800
nextPlanstring

按照调度计划将要生效的 quota 计划

planB
nextTimestring

next_plan 被调度的时间

1700
oncePlanstring

立即生效的 quota 计划。 如果用户触发了立即生效且不同于 curr_plan,那么非空。

planC
onceTimestring

立即生效触发的时间

1500
operatorNamestring

操作人名称。

userA
timezonestring

时区

UTC+8
statusstring

资源状态

ON
tagstring

quota 的资源标签

abc
tenantIdstring

租户 id。

280747109771520
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
versionstring

版本

1
tagstring

quota 的资源标签

abc
tenantIdstring

租户 id。

280747109771520
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
versionstring

版本。

1
Tagsobject []

标签

TagValuestring

标签值。

1
TagKeystring

标签键。

Department
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemlong

每页返回的最大结果数。

10
dataobject

返回数据。

quotaInfoListobject []

quota 列表

idstring

quota id

0
namestring

quota 名称

quota_a
nickNamestring

quota 别名

quota_nickname
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
statusstring

资源状态

ON
tenantIdstring

租户 id。

280747109771520
regionIdstring

地域 id。

cn-beijing
parentIdstring

父资源 id

null
clusterstring

集群 id

AT-120N
versionstring

版本

1
billingPolicyobject

订单信息

odpsSpecCodestring

订单规格

OdpsStandard
orderIdstring

订单 id

45245678
billingMethodstring

付费模式。

  • subscription,表示是预付费 quota。
  • payasyougo,表示是后付费 quota。
subscription
scheduleInfoobject

分时信息

currPlanstring

按照调度计划生效的 quota 计划

planA
currTimestring

currPlan 被调度的时间

0800
nextPlanstring

按照调度计划将要生效的 quota 计划

planB
nextTimestring

next_plan 被调度的时间

1700
oncePlanstring

立即生效的 quota 计划。 如果用户触发了立即生效且不同于 curr_plan,那么非空。

planC
onceTimestring

立即生效触发的时间

1500
operatorNamestring

操作人名称。

userA
timezonestring

时区

UTC+8
parameterobject

quota 的描述信息

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

quota 的资源标签

abc
createTimelong

资源创建时间

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

资源创建者,云账号 UID。

672863518
saleTagobject

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

resourceIdsarray

maxcompute quota 对象的标识,这个标识在阿里云售卖子系统内也存在。通过这个标识,可以把 quota 对象的费用都关联到某个标签上。

string

maxcompute quota 对象的标识

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

对象的类型,目前仅支持 quota 和 project 两种类型。

"quota"
subQuotaInfoListobject []

二级 quota 信息

idstring

二级 quota ID

1000048
namestring

二级 quota 名称

subquotaA
nickNamestring

二级 quota 昵称

subquotaA
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
statusstring

资源状态

ON
tenantIdstring

租户 id。

280747109771520
regionIdstring

地域 id。

cn-beijing
parentIdstring

父资源 id。

0
clusterstring

集群 id

AT-120N
versionstring

版本号

1
billingPolicyobject

订单信息

odpsSpecCodestring

订单规格

OdpsStandard
orderIdstring

订单 id。

45245678
billingMethodstring

付费模式。

  • subscription,表示预付费 quota。
  • payasyougo,表示是后付费 quota。
subscription
scheduleInfoobject

分时信息

currPlanstring

按照调度计划生效的 quota 计划

planA
currTimestring

currPlan 被调度的时间

0800
nextPlanstring

按照调度计划将要生效的 quota 计划

planB
nextTimestring

next_plan 被调度的时间

1700
oncePlanstring

立即生效的 quota 计划。 如果用户触发了立即生效且不同于 curr_plan,那么非空。

planC
onceTimestring

立即生效触发的时间

1500
operatorNamestring

操作人名称。

userA
timezonestring

时区

UTC+8
parameterobject

quota 的描述信息

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

quota 的资源标签

abc
createTimelong

资源创建时间

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

资源创建者,云账号 UID。

672863518
saleTagobject

描述了 MaxCompute quota 对象的标识,这个标识与阿里云售卖账单中的标识是一致的。实际使用与标签场景下。

resourceIdsarray

maxcompute quota 对象的标识,这个标识在阿里云售卖子系统内也存在。通过这个标识,可以把 quota 对象的费用都关联到某个标签上。

string

maxcompute quota 对象的标识

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

对象的类型,目前仅支持 quota 和 project 两种类型。

"quota"
Tagsobject []

标签。

TagValuestring

标签值。

a12351qHDP6YEQMt
TagKeystring

标签键。

Department
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItemlong

每页返回的最大结果数。

10
NextTokenstring

分页标识,当前接口仅支持连续翻页。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。

"abcde"
NextTokenstring

分页标识,当前接口仅支持连续翻页。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。

AAAAAdDWBF2w6Olxc+cMPjUtUMo/CvPe4IK7f7kIQFrIZjyc

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-04-14新增 OpenAPI看变更集
  • 本页导读 (1)