Tunnel メトリクス詳細 API リファレンス - MaxCompute - Alibaba Cloud - MaxCompute

指定された時間範囲におけるトンネルデータ転送サービスの詳細を照会します。

操作説明

注意事項

この API を使用して、スロット使用量の詳細 (slot_usage_detail)、スループットの詳細 (throughput_detail)、スループットの概要 (throughput_summary) などのトンネルメトリックを照会できます。
quotaNickname パラメーターと project パラメーターの両方を空にすることはできません。
groupList パラメーターに table または ip が含まれる場合、project パラメーターは必須です。groupList に ip が含まれる場合、tableList パラメーターも必須です。
orderColumn パラメーターは maxValue、minValue、avgValue、および sumValue (throughput_summary のみ) をサポートします。このパラメーターを省略した場合、結果はソートされません。
ascOrder パラメーターのデフォルト値は false (降順) です。
limit パラメーターは返す結果の数を指定します。デフォルトは 10、最大は 100 です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

odps:QueryTunnelMetricDetail

list

*Tunnel

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
metric	string	必須	メトリック名。列挙値: slot_usage_detail : スロット使用量の詳細。 throughput_summary : スループットの概要。 throughput_detail : スループットの詳細。	slot_usage_detail

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
startTime	integer	必須	クエリ時間範囲の開始時刻。これは秒単位の UNIX タイムスタンプです。	1735534322
endTime	integer	必須	クエリ時間範囲の終了時刻。これは秒単位の UNIX タイムスタンプです。	1735536322
body	object	任意	リクエストボディのパラメーター。
quotaNickname	string	任意	レベル 2 トンネルクォータのニックネーム。共有クォータのニックネームは `default` です。専用クォータの場合、ニックネームは `quotaNickname#subQuotaNickname` 形式になります。	quota_A
project	string	任意	プロジェクト名。	project_a
tableList	array	任意	テーブル名のリスト。 `project` パラメーターは、テーブルのリストを指定する場合に必須です。すべてのテーブルは指定されたプロジェクトに属している必要があります。
	string	任意	テーブル名。	tab_name
operationList	array	任意	操作タイプのリスト。
	string	任意	操作タイプ。有効な値： `upload`：バッチトンネルアップロード。 `download`：バッチトンネルダウンロード。 `stream_upload`：ストリームトンネルアップロード。 `max_storage_read`：ストレージ API ダウンロード。 `download_instance`：トンネルインスタンスダウンロード。 `upsert`：トンネルアップサートアップロード。 `max_storage_write`：ストレージ API アップロード。 `table_preview`：プレビューダウンロード。	upload
groupList	array	任意	グループ化ディメンションのリスト。
	string	任意	グループ化ディメンション。有効な値： `quota` `project` `table` `operation` `ip` (この値は `metric` パラメーターが `throughput_detail` に設定されている場合にのみサポートされます。)	quota
orderColumn	string	任意	ソート列。列挙値: avgValue : 平均値。 minValue : 最小値。 maxValue : 最大値。 sumValue : 合計値。	maxValue
ascOrder	boolean	任意	結果を昇順でソートするかどうかを指定します。このパラメーターを `true` に設定すると、結果は昇順でソートされます。`false` に設定するか、未指定のままにすると、結果は降順でソートされます。	false
limit	integer	任意	返す最大エントリ数。デフォルト：10。最大：100。	10
codeList	array	任意	結果をフィルタリングするためのエラーコードのリスト。
	integer	任意	400 や 500 などのエラーコード。	403

slot_usage_detail スロット使用量の詳細データの上位 N 件のエントリを返します。オプションのフィルタリングパラメーター：`quotaNickname`、`project`、`tableList`、`operationList`、`groupList`。`quotaNickname` と `project` パラメーターの両方を省略することはできません。`orderColumn` パラメーターには `maxValue`、`minValue`、または `avgValue` を設定できます。デフォルトでは、このパラメーターは空で、ソートは実行されません。`ascOrder` パラメーターのデフォルト値は `false` で、結果が降順でソートされることを示します。`limit` パラメーターのデフォルト値は 10 で、最大値は 100 です。`groupList` パラメーターには `quota`、`project`、`table`、または `operation` を設定できます。`groupList` パラメーターは空にできず、表示するデータの粒度を指定します。 throughput_detail スループットの詳細データの上位 N 件のエントリを返します。オプションのフィルタリングパラメーター：`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>	メトリック値。
	array<object>	メトリックデータポイントのリスト。
metric	object	メトリックメタデータ。
	string	メタデータ。キーはディメンションを表し、値はそのディメンションの値です。	"project":"prjName"
value	object	メトリックの数値。	"avgValue":"11.5"

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。