文档

GetQuota - 获取指定一级Quota组信息

更新时间:

获取指定一级Quota组信息。 注意warning: 该接口会在2024年7月31日下线,我们会提供QueryQuota的接口替代,入参,出参,功能完全一样。

调试

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

授权信息

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

请求语法

GET /api/v1/quotas/{nickname}

请求参数

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

Quota 名称

%E9%BB%98%E8%AE%A4%E9%A2%84%E4%BB%98%E8%B4%B9Quota_p #中文名称需要经过utf8 urlencode编码转义
tenantIdstring

租户 id

520539530998273
regionstring

地域 id。

cn-chengdu
AkProvenstring

ak 换取凭证

null
mockboolean

是否包含子模块。取值:-true:包含。-false(默认值):不包含。

false

返回参数

名称类型描述示例值
object

PopCompatibleResult

billingPolicyobject

订单信息

billingMethodstring

付费模式。

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

订单规格

OdpsStandard
orderIdstring

订单 id。

45245678
saleTagobject

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

resourceIdsarray

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

string

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

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

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

"quota"
clusterstring

集群 id。

AT-120N
createTimelong

资源的创建时间

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

资源创建者,云账号 UID。

672863518
requestIdstring

请求 id。

0b87b7a316654730544735643e9200
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
subQuotaInfoListarray<object>

二级 quota 信息

object

数据

billingPolicyobject

订单信息

billingMethodstring

付费模式。

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

订单规格

OdpsStandard
orderIdstring

订单 id。

45245678
saleTagobject

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

resourceIdsarray

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

string

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

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

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

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

478403690625249
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
versionstring

版本号

1
tagstring

quota 的资源标签

abc
tenantIdstring

租户 id。

478403690625249
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
versionstring

版本号。

1
dataobject

返回数据。

idstring

quota ID

0
namestring

quota 名称

quota_a
nickNamestring

Quota 别名

quota_nickname
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
statusstring

资源状态

ON
saleTagobject

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

resourceIdsarray

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

string

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

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

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

"quota"
tenantIdstring

租户 id。

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

二级 quota 信息

object

数据

idstring

二级 quota ID

1000048
namestring

二级 quota 名称

subquotaA
saleTagobject

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

resourceIdsarray

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

string

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

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

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

"quota"
nickNamestring

二级 quota 昵称

subquotaA
typestring

对应控制集群的 resourceSystemType 字段

FUXI_ONLINE
statusstring

资源状态

ON
tenantIdstring

租户 id。

478403690625249
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 的描述信息

tagstring

quota 的资源标签

abc
createTimelong

资源创建时间

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

资源创建者,云账号 UID。

672863518

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-21OpenAPI 返回结构发生变更查看变更详情
2023-08-22OpenAPI 返回结构发生变更查看变更详情
2022-04-14新增 OpenAPI查看变更详情