調用QueryTunnelMetricDetail查詢Tunnel資源觀測詳情資料-雲原生MaxCompute MaxCompute-阿里雲

用於查詢指定時間範圍內的TunnelData Transmission Service相關詳情資料。

介面說明

請求說明

本 API 支援查詢包括 slot 使用量詳情(slot_usage_detail)、輸送量詳情(throughput_detail)和輸送量匯總(throughput_summary)等在內的多種 Tunnel 指標。
quotaNickname 和 project 參數不能同時為空白。
當 groupList 包含 table 或 ip 時，必須指定 project 參數，並且在包含 ip 時還需指定 tableList 參數。
orderColumn 支援 maxValue, minValue, avgValue 和 sumValue（僅適用於 throughput_summary），預設為空白表示不排序。
ascOrder 預設為 false 表示降序排列。
limit 參數定義了返回結果的數量限制，預設值為 10，最大不超過 100。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

odps:QueryTunnelMetricDetail

list

*Tunnel

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

無

請求文法

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

請求參數

名稱	類型	必填	描述	樣本值
startTime	integer	是	查詢時間範圍：開始時間。	1735534322
endTime	integer	是	查詢時間範圍：結束時間。	1735536322
metric	string	是	觀測指標名稱。	slot_usage_detail
body	object	否	請求體參數。
quotaNickname	string	否	Tunnel 二級 Quota 暱稱。共用 Quota 暱稱是：default 獨享 Quota 暱稱的格式是：quotaNickname#subQuotaNickname	quota_A
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
groupList	array	否	分組依據列表
	string	否	分組依據。包括： quota project table operation ip (僅 metric 為 throughput_detail 時支援)	quota
orderColumn	string	否	排序列	maxValue
ascOrder	boolean	否	是否升序	false
limit	integer	否	查詢的數量限制。預設是 10，最大 100。	10

slot_usage_detail

slot 使用量 TopN 詳情資料
支援可選過濾參數：quotaNickname,project,tableList,operationList,groupList
- quotaNickname 和 project 不能同時為空白
- orderColumn 只支援 maxValue，minValue 和 avgValue。預設為空白，表示不排序
- ascOrder 預設為 false，表示降序
- limit 預設為 10，最大 100
groupList 支援 quota,project,table,operation。
- groupList 不可為空，表示資料的展示粒度。

throughput_detail

輸送量 TopN 詳情資料
支援可選過濾參數：quotaNickname,project,tableList,operationList,groupList
- quotaNickname 和 project 不能同時為空白
- orderColumn 只支援 maxValue，minValue 和 avgValue。預設為空白，表示不排序
- ascOrder 預設為 false，表示降序
- limit 預設為 10，最大 100
groupList 支援 quota,project,table,ip,operation
- groupList 不可為空，表示資料的展示粒度。

throughput_summary

輸送量匯總
支援可選過濾參數：quotaNickname,project,tableList,operationList,groupList
- quotaNickname 和 project 不能同時為空白
- orderColumn 只支援 sumValue。預設為空白，表示不排序
- ascOrder 預設為 false，表示降序
- limit 預設為 10，最大 100
groupList 支援 quota,project,table,operation
- groupList 不可為空，表示資料的展示粒度。

返回參數

名稱	類型	描述	樣本值
	object	PopResult
requestId	string	請求 ID。	0a06dd4516687375802853481ec9fd
httpCode	integer	返回的 HTTP 狀態代碼。	200
errorCode	string	錯誤碼。	OBJECT_NOT_EXIST
errorMsg	string	錯誤資訊。	plan \"***\" does not exist
data	object	返回資料
name	string	觀測指標名稱。	tableA
metrics	array<object>	指標值。
	object	指標值。
metric	object	指標中繼資料資訊。
	string	中繼資料資訊。其中，key 是分組依據，value 是對應的中繼資料。	"project":"prjName"
value	object	指標數值資訊	"avgValue":"11.5"

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。