すべてのプロダクト
Search

このプロダクト

    :DescribeMetricList

    ドキュメントセンター

    :DescribeMetricList

    最終更新日:Nov 14, 2025

    DescribeMetricList 操作を呼び出して、クラウドサービスの特定のメトリックのモニタリングデータをクエリします。

    操作説明

    制限

    • DescribeMetricLast、DescribeMetricList、DescribeMetricData、および DescribeMetricTop 操作には、月あたり 100 万回の API 呼び出しの無料クォータがあります。無料クォータを使い切った場合、基本 CloudMonitor の従量課金方法を有効にしない限り、これらの API 操作を呼び出すことはできません。無料クォータを超えた API 呼び出しは課金されます。従量課金方法を有効にする方法の詳細については、「従量課金を有効にする」をご参照ください。

    • 各 API 操作は、1 秒あたり最大 50 回呼び出すことができます。この制限は、Alibaba Cloud アカウントとその RAM ユーザー間で共有されます。

    説明

    API 操作を呼び出すときに Throttling.User または Request was denied due to user flow control エラーメッセージが表示された場合、API 呼び出しがスロットルされていることを意味します。この問題を解決する方法の詳細については、「API 呼び出しのスロットルの問題を解決するにはどうすればよいですか？」をご参照ください。

    注意

    各クラウドサービスのモニタリングデータのストレージ期間は、Period (統計期間) によって決まります。Period の値が大きいほど、クエリされたモニタリングデータの粒度が低くなり、より長期間保存できることを示します。次のリストにその関係を示します。

    • Period の値が 60 秒未満の場合、ストレージ期間は 7 日間です。

    • Period の値が 60 秒の場合、ストレージ期間は 31 日間です。

    • Period の値が 300 秒以上の場合、ストレージ期間は 91 日間です。

    使用上の注意

    このトピックでは、acs_ecs_dashboard クラウドサービスの cpu_idle メトリックのモニタリングデータをクエリする方法の例を示します。応答は、Alibaba Cloud アカウント 120886317861**** に属するインスタンス i-abcdefgh12**** について、60 秒間隔でメトリックの最大値、最小値、平均値がそれぞれ 100、93.1、99.52 であることを示しています。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Namespace

    string

    必須

    クラウドサービスの名前空間。

    クラウドサービスの名前空間の詳細については、「メトリック」をご参照ください。

    acs_ecs_dashboard
    MetricName

    string

    必須

    メトリックの名前。

    クラウドサービスのメトリックの詳細については、「メトリック」をご参照ください。

    cpu_idle
    Period

    string

    任意

    モニタリングデータの統計期間。

    有効な値: 15、60、900、3600。

    単位: 秒。

    説明

    • このパラメーターを設定しない場合、モニタリングデータは、メトリックの登録時に指定したレポート期間に基づいてクエリされます。

    • クラウドサービスの各メトリック (MetricName) の統計期間は異なります。詳細については、「メトリック」をご参照ください。

    60
    StartTime

    string

    任意

    クエリする時間範囲の開始時刻。次のフォーマットがサポートされています:

    • UNIX タイムスタンプ: 1970 年 1 月 1 日からのミリ秒数。

    • フォーマット: YYYY-MM-DD hh:mm:ss。

    説明

    • 指定された時間範囲は左開右閉区間です。StartTime の値は EndTime の値より前でなければなりません。

    • StartTime と EndTime の間隔は 31 日以下でなければなりません。

    2019-01-30 00:00:00
    EndTime

    string

    任意

    クエリする時間範囲の終了時刻。次のフォーマットがサポートされています:

    • UNIX タイムスタンプ: 1970 年 1 月 1 日からのミリ秒数。

    • フォーマット: YYYY-MM-DD hh:mm:ss。

    説明

    StartTime と EndTime の間隔は 31 日以下でなければなりません。

    2019-01-30 00:10:00
    Dimensions

    string

    任意

    モニター対象のリソースを指定するディメンション。

    フォーマット: キーと値のペアのコレクション。例: {"userId":"120886317861****"} および {"instanceId":"i-2ze2d6j5uhg20x47****"}。

    説明

    1 回のリクエストで最大 50 個のインスタンスをクエリできます。

    [{"instanceId":"i-2ze2d6j5uhg20x47****"}]
    NextToken

    string

    任意

    ページネーションカーソル。

    説明

    このパラメーターを設定しない場合、データは最初のページからクエリされます。このパラメーターに値が返された場合、すべてのデータが返されていないことを示します。その値を新しいトークンとして使用して次のクエリを開始し、データの次のページを取得できます。値が返されない場合は、すべてのデータが返されたことを示します。

    15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****
    Length

    string

    任意

    ページングクエリで各ページに返すエントリ数。

    説明

    1 回のリクエストにおける Length の最大値は 1440 です。

    1000
    Express

    string

    任意

    クエリ結果に基づいてリアルタイムコンピューティングに使用される式。

    説明

    groupby 式のみがサポートされています。この式は、データベースの GROUP BY 文に似ています。

    {"groupby":["userId","instanceId"]}

    共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NextToken

    string

    ページネーションカーソル。

    15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
    RequestId

    string

    リクエスト ID。

    3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
    Success

    boolean

    操作が成功したかどうかを示します。有効な値:

    • true: 操作は成功しました。

    • false: 操作は失敗しました。

    true
    Datapoints

    string

    モニタリングデータのリスト。

    [{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]
    Code

    string

    状態コード。

    説明

    値 200 は、呼び出しが成功したことを示します。

    200
    Message

    string

    エラーメッセージ。

    The specified resource is not found.
    Period

    string

    間隔。単位: 秒。有効な値: 60、300、900。

    60

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Success": true,
  "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"120886317861****\",\"instanceId\":\"i-abc\",\"Minimum\":9.92,\"Average\":9.92,\"Maximum\":9.92}]",
  "Code": "200",
  "Message": "The specified resource is not found.",
  "Period": "60"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 %s %s
    500 InternalError The request processing has failed due to some unknown error.
    403 %s %s
    404 ResourceNotFound The specified resource is not found. The specified resource is not found.

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

    変更履歴

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