GetQuotaUsage - 获取Quota资源消耗信息_云原生大数据计算服务 MaxCompute(MaxCompute)-阿里云帮助中心

获取Quota资源消耗信息

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
odps:GetQuotaUsage	get	*Quota `acs:odps:{#regionId}:{#accountId}:quotas/{#nickName}`	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
nickname	string	是	一级 Quota 昵称。	os_quota_p
tenantId	string	否	租户 ID。可以通过登录 MaxCompute 控制台，在左侧导航栏选择租户管理>租户属性查看。	478403690625249
region	string	否	地域 ID。	cn-chengdu
from	long	是	查询开始时间点。该时间是指写入日志数据时指定的日志时间。请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。	1669081045
to	long	是	查询结束时间点。该时间是指写入日志数据时指定的日志时间。请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。	1669360870
subQuotaNickname	string	否	二级 Quota 昵称。	ot_tunnel_quota
aggMethod	string	否	聚合算法。当获取计算 Quota 计算资源消耗数据时，为优化页面体验，每个指标至多支持展示 60 个点，因此当时间范围大于 1h 时，图表默认使用区间范围内（所选时间范围的分钟数/60）的平均值聚合数据，您可以根据自身需求更改聚合算法。	max
productId	string	否	Quota 类型。默认为 odps。 ODPS：计算 Quota； TUNNEL：数据传输服务 Quota。	ODPS
plotTypes	array	否	图表类型。
item	string	否	图表类型。当 productId 为 ODPS 时支持参数： cpu：CPU 资源； memory：内存资源；不填表示两个指标均需返回。当 productId 为 TUNNEL 时必须填写参数，枚举值： request：请求并发数； throughput：吞吐量； error：错误请求数。	cpu
yAxisTypes	array	否	数据指标字段。
item	string	否	数据指标字段。当 productId 为 ODPS 时无需填写。当 productId 为 TUNNEL 时支持填入 project 名称，此时返回的结果是项目维度的信息。	your_project_name

返回参数

名称	类型	描述	示例值
	object	请求返回参数。
requestId	string	请求 ID。	0b87b7a416652014358483492eea0b
httpCode	integer	HTTP 状态码。 1xx：信息响应 - 请求已接收，正在处理中。 2xx：成功 - 请求动作已被服务端成功接收、理解并接受。 3xx：重定向 - 请求被重定向，采取进一步行动以完成请求。 4xx：客户端错误 - 请求包含错误请求参、语法或特定请求条件无法满足。 5xx：服务端错误 - 服务器由于其他原因无法满足请求。	200
errorCode	string	错误码。	OBJECT_NOT_EXIST
errorMsg	string	错误描述信息。	This object does not exist.
data	object	请求返回结果。
metrics	object	指标结果。	"timestamps": [1668046140000, 1668065220000], //毫秒 "project1#upload#request": [10, 20], "project1#download#request": [20, 30], "project1#upload#throughput": [50, 50], "project1#download#throughput": [60, 70], "pro2#errorNum": [5, 10]
plot	array<object>	图表信息。
plot	object	图表信息。
title	string	图表标题。	项目请求并发数
type	string	图表类型。	request
yAxis	array	数据指标字段。
yAxis	string	数据指标字段。当 productId 为 ODPS 时: cpu 具体类型 memory 具体类型当 productId 为 TUNNEL 且填入 project 名称时： project#operation#type	project1#download#request

示例

正常返回示例

JSON格式

{
  "requestId": "0b87b7a416652014358483492eea0b",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.",
  "data": {
    "metrics": {
      "test": "test",
      "test2": 1
    },
    "plot": [
      {
        "title": "项目请求并发数",
        "type": "request",
        "yAxis": [
          "project1#download#request"
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2022-08-18	新增 OpenAPI	查看变更详情