QueryQuotaMetric API によるクォータ消費量のモニタリング - 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:QueryQuotaMetric

list

*Quota

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
metric	string	必須	メトリックの名前。有効な値: cpu および memory。	cpu

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
startTime	integer	必須	クエリする時間範囲の開始時刻。	1735534322
endTime	integer	必須	クエリする時間範囲の終了時刻。	1735536322
strategy	string	任意	データの集約戦略。デフォルト値は max です。有効な値: max および avg。データは 1 分間隔で収集されます。長い時間範囲をクエリする場合、システムは 1 分より長い間隔を使用してデータを集約することがあります。このパラメーターは、データの集約方法を指定します。	max
body	object	任意	リクエスト本文。
nickname	string	任意	レベル 1 クォータのニックネーム。このパラメーターは必須です。	os_sns_p
subQuotaNickname	string	任意	レベル 2 クォータのニックネーム。	os_sns
interval	integer	任意	固定間隔 (秒単位)。このパラメーターを空のままにすると、システムは自動間隔ポリシーを使用します。自動間隔ポリシー: 6 時間以内の時間範囲では間隔は 60 秒、24 時間以内の時間範囲では 300 秒、72 時間以内の時間範囲では 900 秒、72 時間を超える時間範囲では 1,800 秒です。指定された間隔: 有効な値は 60、300、および 900 です。クエリの時間範囲は 72 時間以内でなければなりません。	60
subMetric	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	PopResult<ObservationMetricDto>
requestId	string	リクエスト ID。	0b87b7b316643495896551555e855b
httpCode	integer	HTTP ステータスコード。 1xx: 情報レスポンス。リクエストは受信され、処理中です。 2xx: 成功。リクエストはサーバーによって正常に受信、理解、および受け入れられました。 3xx: リダイレクト。リクエストはリダイレクトされました。リクエストを完了するには、さらなる操作が必要です。 4xx: クライアントエラー。リクエストに不正なリクエストパラメーターまたは構文が含まれているか、特定のリクエスト条件を満たすことができません。 5xx: サーバーエラー。サーバーは他の理由でリクエストを履行できませんでした。	200
errorCode	string	エラーコード。	success
errorMsg	string	エラーメッセージ。	plan \"***\" does not exist
data	object	返されたデータ。
category	string	このパラメーターはサポートされていません。	不支持。
name	string	メトリックの名前。	cpu
period	integer	モニタリングデータのステップサイズ。	60
metrics	array<object>	メトリック値。
	array<object>	メトリック値。
metric	object	メトリックのメタデータ。
	string	メトリックのメタデータ。 unit: メタデータの単位。メトリックが cpu の場合、単位は Core です。メトリックが memory の場合、単位は GB です。 type: メタデータの型。メトリックが cpu の場合、有効なメタデータの型は totalMaxCpu、totalUsedCpu、adhocCpu、adhocUsedCpu、maxCpu、minCpu、requestCpu、usedCpu、elasticMaxCpu、および elasticUsedCpu です。メトリックが memory の場合、有効なメタデータの型は totalMaxMem、totalUsedMem、adhocMem、adhocUsedMem、elasticMaxMem、elasticUsedMem、maxMem、minMem、および usedMem です。	totalUsedCpu
values	array	時系列データ。
	array	2 つの要素を持つ配列。最初の要素はタイムスタンプで、2 番目の要素は値です。
	number	2 つの要素を持つ配列。最初の要素はタイムスタンプで、2 番目の要素は値です。	[1757571840,10]

例

成功レスポンス

JSONJSON

{
  "requestId": "0b87b7b316643495896551555e855b",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "category": "不支持。",
    "name": "cpu",
    "period": 60,
    "metrics": [
      {
        "metric": {
          "key": "totalUsedCpu"
        },
        "values": [
          [
            0
          ]
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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