QueryTunnelMetric API による MaxCompute Tunnel 使用量監視 - MaxCompute

指定された時間範囲内の Tunnel Data Transmission Service のメトリックデータをクエリします。

操作説明

リクエストの説明

この API を使用して、スロット使用量 (slot_usage)、スロット使用量上限 (slot_max)、スループット (throughput)、スループットレート (throughput_speed)、リクエスト数 (request) など、さまざまな Tunnel メトリックをクエリできます。
startTime と endTime パラメーターは必須です。これらはクエリの時間範囲の開始と終了を指定します。値は秒単位の UNIX タイムスタンプです。
metric パラメーターも必須です。クエリするメトリックのタイプを指定します。
metric の値によっては、クエリを絞り込むためにフィルタリング用の追加パラメーターを指定する必要がある場合があります。これらのパラメーターには、quotaNickname、project、tableList、operationList、codeList、groupList、topN が含まれます。
一部の metric 値では、他のパラメーターを指定する必要があります。たとえば、groupList に table または ip が含まれている場合、project パラメーターとその他の必須パラメーターを指定する必要があります。この場合、システムは上位 N 件の結果のみを返します。
strategy パラメーターは、データ集約ロジックを定義します。このロジックは、長い時間範囲で自動ステップサイズが 60 秒を超えた場合に使用されます。デフォルト値は max です。
リクエストの失敗を防ぐために、すべてのパラメーターがこのドキュメントの要件を満たしていることを確認してください。

今すぐお試しください

この 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:QueryTunnelMetric

list

*Tunnel

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

なし

リクエスト構文

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

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
metric	string	必須	メトリックの名前。列挙値: request : リクエスト slot_max : slot_max slot_usage : slot_usage throughput : スループット throughput_speed : throughput_speed	slot_usage

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
startTime	integer	必須	クエリの時間範囲の開始。	1735534322
endTime	integer	必須	クエリの時間範囲の終了。	1735536322
strategy	string	任意	データ集約ポリシー。デフォルト値は `max` です。データは 1 分の頻度で収集されます。長い時間範囲でデータをクエリする場合、データ表示の自動ステップサイズが 1 分を超えることがあります。この場合、メトリックは集約されます。このパラメーターは集約ロジックを指定します。列挙値: avg : avg max : max	max
body	object	任意	リクエスト本文のパラメーター。
quotaNickname	string	任意	レベル 2 Tunnel クォータのニックネーム。共有クォータのニックネームは `default` です。専用クォータのニックネームのフォーマットは `quotaNickname#subQuotaNickname` です。	default
project	string	任意	プロジェクトの名前。	project_a
tableList	array	任意	テーブル名のリスト。テーブルはプロジェクトに属します。したがって、`tableList` が空でない場合、`project` は空にできません。
	string	任意	テーブルの名前。	tab_name
operationList	array	任意	操作タイプのリスト。
	string	任意	操作タイプ。有効な値は次のとおりです。 upload: Tunnel バッチアップロード download: Tunnel バッチダウンロード stream_upload: Tunnel ストリームアップロード max_storage_read: Storage API ダウンロード download_instance: Tunnel インスタンスダウンロード upsert: Tunnel upsert アップロード max_storage_write: Storage API アップロード table_preview: プレビューダウンロード列挙値: download : download max_storage_read : max_storage_read max_storage_write : max_storage_write upload : upload upsert : upsert table_preview : table_preview download_instance : download_instance stream_upload : stream_upload	upload
codeList	array	任意	リクエストの HTTP ステータスコードのリスト。
	integer	任意	HTTP ステータスコード。	403
groupList	array	任意	グループ化基準のリスト。
	string	任意	グループ化基準。有効な値は次のとおりです。 quota project table operation ip (`metric` が `throughput` の場合にのみサポートされます) code (`metric` が `request` の場合にのみサポートされます)	quota
topN	integer	任意	返すデータエントリの最大数。このパラメーターは、グループ化基準に `table` または `ip` が含まれている場合に有効になります。デフォルト値は 10 です。最大値は 100 です。	10

slot_usage

説明: スロット使用量。
サポートされているオプションのフィルタリングパラメーター: quotaNickname、project、tableList、operationList、groupList、および topN。
- `quotaNickname` または `project` の少なくとも 1 つを指定する必要があります。
- `tableList` と `topN` パラメーターは、`project` が指定され、`groupList` に `table` が含まれている場合にのみ適用されます。
サポートされている groupList の値: quota、project、table、および operation。
- `groupList` を指定する必要があります。このパラメーターは、データ表示の粒度を指定します。
- quotaNickname が default に設定されている場合、groupList には project を含める必要があります。これは、共有クォータがプロジェクトレベルであるためです。
- groupList に table が含まれている場合は、project パラメーターを指定する必要があります。その場合、システムは上位 N 件の時系列データのみを返します。

slot_max

説明: スロット使用量の上限。
quotaNickname パラメーターは必須です。
- quotaNickname が default に設定されている場合、project パラメーターを指定する必要があります。これは、共有クォータがプロジェクトレベルであるためです。
サポートされている groupList の値: quota および project。

throughput

説明: スループット。
サポートされているオプションのフィルタリングパラメーター: quotaNickname、project、tableList、operationList、groupList、および topN。
- `quotaNickname` または `project` の少なくとも 1 つを指定する必要があります。
- `tableList` と `topN` パラメーターは、`project` が指定され、`groupList` に `table` または `ip` が含まれている場合にのみ適用されます。
サポートされている groupList の値: quota、project、table、ip、および operation。
- `groupList` を指定する必要があります。このパラメーターは、データ表示の粒度を指定します。
- groupList に table が含まれている場合は、project パラメーターを指定する必要があります。その場合、システムは上位 N 件の時系列データのみを返します。
- groupList に ip が含まれている場合は、project と tableList パラメーターを指定する必要があります。その場合、システムは上位 N 件の時系列データのみを返します。

throughput_speed

説明: スループットレート。
サポートされているオプションのフィルタリングパラメーター: quotaNickname、project、tableList、operationList、groupList、および topN。
- `quotaNickname` または `project` の少なくとも 1 つを指定する必要があります。
- `tableList` と `topN` パラメーターは、`project` が指定され、`groupList` に `table` が含まれている場合にのみ適用されます。
サポートされている groupList の値: quota、project、table、および operation。
- `groupList` を指定する必要があります。このパラメーターは、データ表示の粒度を指定します。
- groupList に table が含まれている場合は、project パラメーターを指定する必要があります。その場合、システムは上位 N 件の時系列データのみを返します。

request

説明: リクエスト数。
サポートされているオプションのフィルタリングパラメーター: quotaNickname、project、tableList、operationList、codeList、groupList、および topN。
- `quotaNickname` または `project` の少なくとも 1 つを指定する必要があります。
- `tableList` と `topN` パラメーターは、`project` が指定され、`groupList` に `table` が含まれている場合にのみ適用されます。
サポートされている groupList の値: quota、project、table、operation、および code。
- `groupList` を指定する必要があります。このパラメーターは、データ表示の粒度を指定します。
- groupList に table が含まれている場合は、project パラメーターを指定する必要があります。その場合、システムは上位 N 件の時系列データのみを返します。

レスポンスフィールド

フィールド	型	説明	例
	object	PopResult<ObservationMetricDto>
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	メタデータ。キーはグループ化基準で、値は対応するメタデータです。	"project":"prjName"
values	array	メトリック値のリスト。
	array	2 つの要素 (タイムスタンプと値) の配列。
	number	タイムスタンプとメトリック値。	[1745220780,1]

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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