Tunnel Metric Details API Reference - MaxCompute - Alibaba Cloud - MaxCompute

Queries details about the Tunnel Data Transmission Service for a specified time range.

Operation description

Usage notes

You can use this API to query Tunnel metrics, including slot usage details (slot_usage_detail), throughput details (throughput_detail), and a throughput summary (throughput_summary).
The quotaNickname and project parameters cannot both be empty.
If the groupList parameter includes table or ip, the project parameter is required. If groupList includes ip, the tableList parameter is also required.
The orderColumn parameter supports maxValue, minValue, avgValue, and sumValue (only for throughput_summary). If this parameter is omitted, the results are not sorted.
The ascOrder parameter defaults to false (descending order).
The limit parameter specifies the number of results to return, with a default of 10 and a maximum of 100.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

odps:QueryTunnelMetricDetail

list

*Tunnel

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
metric	string	Yes	The metric name. Valid values: slot_usage_detail : Slot usage details. throughput_summary : Throughput summary. throughput_detail : Throughput details.	slot_usage_detail

Request parameters

Parameter	Type	Required	Description	Example
startTime	integer	Yes	The start of the query time range. This is a Unix timestamp in seconds.	1735534322
endTime	integer	Yes	The end of the query time range. This is a Unix timestamp in seconds.	1735536322
body	object	No	The request body parameters.
quotaNickname	string	No	The nickname of the level-2 tunnel quota. The nickname for a shared quota is `default`. For an exclusive quota, the nickname is in the `quotaNickname#subQuotaNickname` format.	quota_A
project	string	No	The name of the project.	project_a
tableList	array	No	A list of table names. The `project` parameter is required if you specify a list of tables. All tables must belong to the specified project.
	string	No	The name of the table.	tab_name
operationList	array	No	A list of operation types.
	string	No	The operation type. Valid values: `upload`: Batch tunnel upload. `download`: Batch tunnel download. `stream_upload`: Stream tunnel upload. `max_storage_read`: Storage API download. `download_instance`: Tunnel instance download. `upsert`: Tunnel upsert upload. `max_storage_write`: Storage API upload. `table_preview`: Preview download.	upload
groupList	array	No	The list of grouping dimensions.
	string	No	The grouping dimension. Valid values: `quota` `project` `table` `operation` `ip` (This value is supported only when the `metric` parameter is set to `throughput_detail`.)	quota
orderColumn	string	No	The sort column. Valid values: avgValue : The average value. minValue : The minimum value. maxValue : The maximum value. sumValue : The total value.	maxValue
ascOrder	boolean	No	Specifies whether to sort the results in ascending order. If you set this parameter to `true`, the results are sorted in ascending order. If you set this to `false` or leave it unspecified, the results are sorted in descending order.	false
limit	integer	No	The maximum number of entries to return. Default: 10. Maximum: 100.	10
codeList	array	No	A list of error codes to filter the results.
	integer	No	An error code, such as 400 or 500.	403

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	The request ID.	0a06dd4516687375802853481ec9fd
httpCode	integer	The HTTP status code.	200
errorCode	string	The error code.	OBJECT_NOT_EXIST
errorMsg	string	The error message.	plan \"***\" does not exist
data	object	The response data.
name	string	The metric name.	tableA
metrics	array<object>	The metric values.
	array<object>	A list of metric data points.
metric	object	The metric metadata.
	string	The metadata. The key represents a dimension, and the value is the value of that dimension.	"project":"prjName"
value	object	The metric's numerical values.	"avgValue":"11.5"

Examples

Success response

JSON format

{
  "requestId": "0a06dd4516687375802853481ec9fd",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "name": "tableA",
    "metrics": [
      {
        "metric": {
          "key": "\"project\":\"prjName\""
        },
        "value": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.