QueryTunnelMetric - Tunnel资源观测时序数据_云原生大数据计算服务 MaxCompute(MaxCompute)-阿里云帮助中心

用于查询指定时间范围内的Tunnel数据传输服务相关指标数据。

接口说明

请求说明

本 API 支持查询包括 slot 使用量(slot_usage)、slot 使用上限(slot_max)、吞吐量(throughput)、吞吐量速率(throughput_speed)以及请求数(request)等在内的多种 Tunnel 指标。
startTime与endTime为必选参数，分别代表查询的时间段起始和结束时间戳（秒）。
metric参数也是必需的，用来指定要查询的具体指标类型。
根据不同的metric值，可能需要提供额外的过滤参数如quotaNickname, project, tableList, operationList, codeList, groupList及topN等来进一步细化查询条件。
特别注意的是，对于某些特定的metric（例如当groupList包含table或ip时），必须同时指定相关的项目(project)和其他必要参数，并且系统会强制返回 Top N 的结果。
参数strategy定义了在较长时间范围内数据自适应步长超过 60 秒时的数据聚合逻辑，默认为max。
确保所有提供的参数符合文档中列出的要求以避免请求失败。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

odps:QueryTunnelMetric

list

*Tunnel

acs:odps:{#regionId}:{#accountId}:tunnel/{#metric}

无

请求语法

POST /api/v1/observations/tunnel/{metric} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
startTime	integer	是	查询时间范围：开始时间。	1735534322
endTime	integer	是	查询时间范围：结束时间。	1735536322
metric	string	是	观测指标名称。	slot_usage
strategy	string	否	数据聚合策略。默认 max。数据的采集频率是 1 分钟。当查询的时间范围较大时，数据展示的自适应步长会超过 1 分钟，此时指标会进行聚合。该参数即指定数据的聚合逻辑。	max
body	object	否	请求体参数。
quotaNickname	string	否	Tunnel 二级 Quota 昵称。共享 Quota 昵称是：default 独享 Quota 昵称的格式是：quotaNickname#subQuotaNickname	default
project	string	否	项目名称。	project_a
tableList	array	否	表名称列表归属于 project，因此如果 tableList 不为空，则 project 不为空。
	string	否	表名称	tab_name
operationList	array	否	操作类型列表
	string	否	操作类型｜包括： upload - Tunnel Batch 上传 download - Tunnel Batch 下载 stream_upload - Tunnel Stream 上传 max_storage_read - Storage API 下载 download_instance - Tunnel Instance 下载 upsert - Tunnel Upsert 上传 max_storage_write - Storage API 上传 table_preview - Preview 下载	upload
codeList	array	否	请求的 HTTP CODE 列表
	integer	否	HTTP CODE	403
groupList	array	否	分组依据列表
	string	否	分组依据。包括： quota project table operation ip (仅 metric 为 throughput 时支持) code (仅 metric 为 request 时支持)	quota
topN	integer	否	数据数量限制。当分组依据包含 table 或 ip 时，该参数生效。默认是 10，最大不超过 100。	10

slot_usage

slot 使用量
支持可选过滤参数：quotaNickname,project,tableList,operationList,groupList,topN
- quotaNickname 和 project 不能同时为空
- tableList 和 topN 仅在指定 project 且 groupList 包含 table 时生效。
groupList 支持 quota,project,table,operation。
- groupList 不能为空，表示数据的展示粒度。
- 当 quotaNickname=default 时，groupList 必须包含 project。（因为共享 quota 是 project 级别的）
- 当 groupList 包含 table 时，必须指定 project 参数。此时，系统强制返回 TopN 的时序数据。

slot_max

slot 使用上限。
quotaNickname 必选。
- 当 quotaNickname=default 时，必须指定 project 参数。（因为共享 quota 是 project 级别的）
groupList 只支持 quota,project

throughput

吞吐量
支持可选过滤参数：quotaNickname,project,tableList,operationList,groupList,topN
- quotaNickname 和 project 不能同时为空
- tableList 和 topN 仅在指定 project 且 groupList 包含 table 或 ip 时生效。
groupList 支持 quota,project,table,ip,operation
- groupList 不能为空，表示数据的展示粒度。
- 当 groupList 包含 table 时，必须指定 project 参数。此时，系统强制返回 TopN 的时序数据。
- 当 groupList 包含 ip 时，必须指定 project 参数和 tableList 参数。此时，系统强制返回 TopN 的时序数据。

throughput_speed

吞吐量速率
支持可选过滤参数：quotaNickname,project,tableList,operationList,groupList,topN
- quotaNickname 和 project 不能同时为空
- tableList 和 topN 仅在指定 project 且 groupList 包含 table 时生效。
groupList 支持 quota,project,table,operation
- groupList 不能为空，表示数据的展示粒度。
- 当 groupList 包含 table 时，必须指定 project 参数。此时，系统强制返回 TopN 的时序数据。

request

请求数
支持可选过滤参数：quotaNickname,project,tableList,operationList,codeList,groupList,topN
- quotaNickname 和 project 不能同时为空
- tableList 和 topN 仅在指定 project 且 groupList 包含 table 时生效。
groupList 支持 quota,project,table,operation,code
- groupList 不能为空，表示数据的展示粒度。
- 当 groupList 包含 table 时，必须指定 project 参数。此时，系统强制返回 TopN 的时序数据。

返回参数

名称	类型	描述	示例值
	object	PopResult
requestId	string	请求 ID。	0bc3b4b016674434996033675e71ee
httpCode	integer	业务成功与否。如果非空且不是 200，那么表示业务处理失败。	200
errorCode	string	错误码。	success
errorMsg	string	错误描述信息。	0A3B1E82006A23A918C70905BF08AEC7
data	object	返回数据
category	string	观测指标所属类别。	tunnel
name	string	观测指标名称。	slot_usage
period	integer	监控数据步长。	60
metrics	array<object>	指标值。
	object	指标值。
metric	object	指标元数据信息。
	string	元数据信息。其中，key 是分组依据，value 是对应的元数据。	"project":"prjName"
values	array	指标数值列表。
	array	长度为 2，分别是时间戳和数值。
	number	时间戳和指标数值。	[1745220780,1]

示例

正常返回示例

JSON格式

{
  "requestId": "0bc3b4b016674434996033675e71ee",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "0A3B1E82006A23A918C70905BF08AEC7",
  "data": {
    "category": "tunnel",
    "name": "slot_usage",
    "period": 60,
    "metrics": [
      {
        "metric": {
          "key": "\"project\":\"prjName\""
        },
        "values": [
          [
            0
          ]
        ]
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。