DescribeMetricData - Cloud Monitor - Alibaba Cloud ドキュメントセンター

操作説明

制限事項

`DescribeMetricLast`、`DescribeMetricList`、`DescribeMetricData`、および `DescribeMetricTop` 操作には、毎月合計 100 万回の無料クォータがあります。無料クォータを使い切り、CloudMonitor Basic (従量課金) が有効化されていない場合、これらの API 操作は期待どおりに呼び出すことができなくなります。 CloudMonitor Basic (従量課金) を有効化している場合、無料クォータを使い切ってもこれらの API 操作を呼び出すことができます。無料クォータを使い切った場合、超過分については従量課金制の課金方法に基づいて自動的に課金されます。 CloudMonitor Basic (従量課金) を有効化する方法の詳細については、「従量課金制の課金方法を有効にする」をご参照ください。
各 API 操作は、毎秒 10 回まで呼び出すことができます。 Alibaba Cloud アカウントと、そのアカウント内の Resource Access Management (RAM) ユーザーは、このクォータを共有します。

説明

`DescribeMetricList` とは異なり、`DescribeMetricData` 操作は統計機能を提供します。 `Dimension` パラメーターを `{"instanceId": "i-abcdefgh12****"}` に設定して、ご利用の Alibaba Cloud アカウントのすべてのデータを集計できます。

このトピックでは、Elastic Compute Service (ECS) の `cpu_idle` メトリックのモニタリングデータをクエリする方法の例を示します。 ECS の名前空間は `acs_ecs_dashboard` です。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:QueryMetricData

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Namespace	string	必須	クラウドサービスの名前空間です。クラウドサービスの名前空間の詳細については、「付録 1：メトリック」をご参照ください。	acs_ecs_dashboard
MetricName	string	必須	クラウドサービスのモニタリングに使用されるメトリックです。クラウドサービスのメトリックの詳細については、「付録 1：メトリック」をご参照ください。	cpu_idle
Period	string	任意	メトリックの統計期間です。有効な値：15、60、900、3600。単位：秒。説明このパラメーターが指定されていない場合、モニタリングデータはメトリック値がレポートされる期間に基づいてクエリされます。 ``MetricName`` パラメーターで指定されたメトリックの統計期間の詳細については、「付録 1：メトリック」をご参照ください。	60
StartTime	string	任意	モニタリングデータをクエリする時間範囲の開始時刻です。 ``StartTime`` と ``EndTime`` パラメーターが指定されていない場合、最後の統計期間のモニタリングデータがクエリされます。`` ``StartTime`` と ``EndTime`` パラメーターが指定されている場合、指定された時間範囲内の最後の統計期間のモニタリングデータがクエリされます。```` 以下の例は、モニタリングデータがクエリされる期間を決定する方法を示しています： ``Period`` パラメーターを 15 に設定した場合、指定する時間範囲は 20 分以下である必要があります。たとえば、`StartTime` パラメーターを 2021-05-08 08:10:00 に、`EndTime` パラメーターを 2021-05-08 08:30:00 に設定した場合、その時間範囲の最後の 15 秒間のモニタリングデータがクエリされます。 ``Period`` を 60 または 900 に設定した場合、指定する時間範囲は 2 時間以下である必要があります。たとえば、`Period` パラメーターを 60 に、`StartTime` パラメーターを 2021-05-08 08:00:00 に、`EndTime` パラメーターを 2021-05-08 10:00:00 に設定した場合、その時間範囲の最後の 60 秒間のモニタリングデータがクエリされます。 ``Period`` パラメーターを 3600 に設定した場合、指定する時間範囲は 2 日間以下である必要があります。たとえば、`StartTime` パラメーターを 2021-05-08 08:00:00 に、`EndTime` パラメーターを 2021-05-10 08:00:00 に設定した場合、その時間範囲の最後の 3,600 秒間のモニタリングデータがクエリされます。以下のフォーマットがサポートされています： UNIX タイムスタンプ：1970 年 1 月 1 日木曜日 00:00:00 UTC から経過したミリ秒数。 UTC 時間：YYYY-MM-DDThh:mm:ssZ フォーマットに従う UTC 時間。説明 ``StartTime`` パラメーターは、1970 年 1 月 1 日木曜日 00:00:00 UTC より後の時点に設定する必要があります。そうでない場合、このパラメーターは無効になります。タイムゾーンに関連する問題を避けるため、UNIX タイムスタンプを使用することを推奨します。	1618368900000
EndTime	string	任意	モニタリングデータをクエリする時間範囲の終了時刻です。 ``StartTime`` と ``EndTime`` パラメーターが指定されていない場合、最後の統計期間のモニタリングデータがクエリされます。`` ``StartTime`` と ``EndTime`` パラメーターが指定されている場合、指定された時間範囲内の最後の統計期間のモニタリングデータがクエリされます。```` 以下の例は、モニタリングデータがクエリされる期間を決定する方法を示しています： ``Period`` パラメーターを 15 に設定した場合、指定する時間範囲は 20 分以下である必要があります。たとえば、`StartTime` パラメーターを 2021-05-08 08:10:00 に、`EndTime` パラメーターを 2021-05-08 08:30:00 に設定した場合、その時間範囲の最後の 15 秒間のモニタリングデータがクエリされます。 ``Period`` を 60 または 900 に設定した場合、指定する時間範囲は 2 時間以下である必要があります。たとえば、`Period` パラメーターを 60 に、`StartTime` パラメーターを 2021-05-08 08:00:00 に、`EndTime` パラメーターを 2021-05-08 10:00:00 に設定した場合、その時間範囲の最後の 60 秒間のモニタリングデータがクエリされます。 ``Period`` パラメーターを 3600 に設定した場合、指定する時間範囲は 2 日間以下である必要があります。たとえば、`StartTime` パラメーターを 2021-05-08 08:00:00 に、`EndTime` パラメーターを 2021-05-10 08:00:00 に設定した場合、その時間範囲の最後の 3,600 秒間のモニタリングデータがクエリされます。以下のフォーマットがサポートされています： UNIX タイムスタンプ：1970 年 1 月 1 日木曜日 00:00:00 UTC から経過したミリ秒数。 UTC 時間：YYYY-MM-DDThh:mm:ssZ フォーマットに従う UTC 時間。説明タイムゾーンに関連する問題を避けるため、UNIX タイムスタンプを使用することを推奨します。	1618368960000
Dimensions	string	任意	リソースをクエリする基準となるディメンションです。値はキーと値のペアのコレクションに設定します。一般的なキーと値のペアは ``instanceId:i-2ze2d6j5uhg20x47****`` です。説明 1 回のリクエストで最大 50 個のインスタンスをクエリできます。	[{"instanceId": "i-abcdefgh12****"}]
Express	string	任意	クエリ結果をリアルタイムで計算するために使用される式です。説明 ``groupby`` 式のみがサポートされています。この式は、データベースで使用される ``GROUP BY`` 文に似ています。	{"groupby":["userId","instanceId"]}
Length	string	任意	1ページあたりのエントリ数です。デフォルト値：1000。説明 1 回のリクエストにおける `Length` パラメーターの最大値は 1440 です。	1000

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

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
Code	string	HTTP ステータスコードです。説明ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージです。	The specified resource is not found.
RequestId	string	リクエスト ID です。	6A5F022D-AC7C-460E-94AE-B9E75083D027
Datapoints	string	モニタリングデータです。この値には次のフィールドが含まれます： ``timestamp``：アラートがトリガーされた時刻。 ``userId``：アラートがトリガーされたユーザーの ID。 ``instanceId``：アラートがトリガーされたインスタンスの ID。 ``Minimum``、``Average``、および ``Maximum``：集計方法。	[{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]
Period	string	モニタリングデータの統計期間です。有効な値：15、60、900、3600。単位：秒。	60

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
  "Datapoints": "[{\\\"timestamp\\\":1618368900000,\\\"Average\\\":95.8291666666667,\\\"Minimum\\\":65.48,\\\"Maximum\\\":100.0},{\\\"timestamp\\\":1618368960000,\\\"Average\\\":95.8683333333333,\\\"Minimum\\\":67.84,\\\"Maximum\\\":100.0}]",
  "Period": "60"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

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

変更履歴

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