GetQuotaUsage API で MaxCompute クォータ使用量を監視 - MaxCompute

クォータリソースの使用状況情報をクエリします。

今すぐお試しください

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

get

*Quota

acs:odps:{#regionId}:{#accountId}:quotas/{#nickName}

なし

リクエスト構文

GET /api/v1/quotas/{nickname}/usage HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
nickname	string	必須	レベル 1 クォータのエイリアス。	os_quota_p

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
tenantId	string	任意	テナントの ID。MaxCompute コンソールにログインし、左側のナビゲーションウィンドウで [テナント] > [テナントプロパティ] を選択して、テナント ID を表示できます。	478403690625249
region	string	任意	リージョン ID。	cn-chengdu
from	integer	必須	クエリの開始時刻。値は、ログデータが書き込まれるときに指定されるログ時刻です。この操作で指定される時間範囲は、左閉右開区間です。この区間には、from パラメーターで指定された開始時刻は含まれますが、to パラメーターで指定された終了時刻は含まれません。from パラメーターと to パラメーターに同じ値を設定した場合、時間範囲は無効となり、エラーメッセージが返されます。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過した秒数を表す UNIX タイムスタンプです。	1669081045
to	integer	必須	クエリの終了時刻。値は、ログデータが書き込まれるときに指定されるログ時刻です。この操作で指定される時間範囲は、左閉右開区間です。この区間には、from パラメーターで指定された開始時刻は含まれますが、to パラメーターで指定された終了時刻は含まれません。from パラメーターと to パラメーターに同じ値を設定した場合、時間範囲は無効となり、エラーメッセージが返されます。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過した秒数を表す UNIX タイムスタンプです。	1669360870
subQuotaNickname	string	任意	レベル 2 クォータのエイリアス。	ot_tunnel_quota
aggMethod	string	任意	集約アルゴリズム。より良いページエクスペリエンスのために、各メトリックに対して最大 60 ポイントまで表示できます。1 時間より長い時間範囲を選択した場合、チャートはデフォルトで範囲内の平均値 (選択した時間範囲の分/60) を使用してデータを集約します。ビジネス要件に基づいて集約アルゴリズムを変更できます。	max
productId	string	任意	クォータタイプ。デフォルト値：ODPS。 ODPS：コンピューティングクォータ TUNNEL：Tunnel クォータ	ODPS
plotTypes	array	任意	チャートのタイプ。
	string	任意	チャートのタイプ。 productId が ODPS に設定されている場合、このパラメーターはオプションであり、次の有効な値があります： cpu：CPU リソース。 memory：メモリリソース。このパラメーターが設定されていない場合、両方のメトリックが返されます。 productId が TUNNEL に設定されている場合、このパラメーターは必須であり、次の有効な値があります： request：リクエスト並列度。 throughput：スループット。 error：エラーリクエストの数。	cpu
yAxisTypes	array	任意	データメトリックフィールド。
	string	任意	データメトリックフィールド。 productId パラメーターが ODPS に設定されている場合、このパラメーターを指定する必要はありません。 productId が TUNNEL に設定されている場合、プロジェクト名を入力できます。この場合、返される結果はプロジェクトディメンションの情報です。	your_project_name

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
requestId	string	リクエスト ID。	0b87b7a416652014358483492eea0b
httpCode	integer	HTTP ステータスコード。 1xx：情報レスポンス。リクエストは受信され、処理中です。 2xx：成功。リクエストはサーバーによって正常に受信、理解、および受け入れられました。 3xx：リダイレクト。リクエストはリダイレクトされ、リクエストを完了するにはさらなる操作が必要です。 4xx：クライアントエラー。リクエストに無効なリクエストパラメーターと構文が含まれているか、特定のリクエスト条件を満たすことができません。 5xx：サーバーエラー。サーバーは他の理由で要件を満たすことができません。	200
errorCode	string	エラーコード。	OBJECT_NOT_EXIST
errorMsg	string	エラーメッセージ。	This object does not exist.
data	object	返されたデータ。
metrics	object	メトリックの結果。
plot	array<object>	チャートに関する情報。
	object	チャートに関する情報。
title	string	チャートのタイトル。	request
type	string	チャートのタイプ。	request
yAxis	array	データメトリックフィールド。
	string	データメトリックフィールド。 productId パラメーターが ODPS に設定されている場合：CPU メトリックタイプまたはメモリメトリックタイプ productId パラメーターが TUNNEL に設定され、プロジェクト名が入力されている場合：project#operation#type	project1#download#request

例

成功レスポンス

JSONJSON

{
  "requestId": "0b87b7a416652014358483492eea0b",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.",
  "data": {
    "metrics": {
      "test": "test",
      "test2": 1
    },
    "plot": [
      {
        "title": "request",
        "type": "request",
        "yAxis": [
          "project1#download#request"
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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