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

操作説明

制限事項

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

注意事項

各クラウドサービスのモニタリングデータのストレージ期間は、`Period` パラメーター (統計期間) に関連しています。`Period` パラメーターの値が大きいほど、モニタリングデータがより広い時間範囲に分散され、モニタリングデータのストレージ期間が長くなります。具体的な関係は次のとおりです：

`Period` パラメーターの値が 60 秒未満の場合、ストレージ期間は 7 日間です。
`Period` パラメーターの値が 60 秒の場合、ストレージ期間は 31 日間です。
`Period` の値が 300 秒以上の場合、ストレージ期間は 91 日間です。

操作の説明

このトピックでは、Elastic Compute Service (ECS) の過去 60 秒間の `cpu_idle` メトリックのモニタリングデータをクエリする方法の例を示します。ECS の名前空間は `acs_ecs_dashboard` です。モニタリングデータは、`Average` フィールドに基づいて降順でソートされます。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Period	string	任意	モニタリングデータの統計期間です。有効値：15、60、900、3600。単位：秒。説明このパラメーターが指定されていない場合、メトリック値がレポートされる期間に基づいてモニタリングデータがクエリされます。統計期間は、`MetricName` で指定されたメトリックによって異なります。詳細については、「付録1：メトリック」をご参照ください。	60
Namespace	string	必須	クラウドサービスの名前空間です。クラウドサービスの名前空間の詳細については、「付録1：メトリック」をご参照ください。	acs_ecs_dashboard
MetricName	string	必須	クラウドサービスをモニターするために使用されるメトリックです。メトリック名の詳細については、「付録1：メトリック」をご参照ください。	cpu_idle
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 から経過したミリ秒数時間フォーマット：YYYY-MM-DDThh:mm:ssZ 説明 `StartTime` パラメーターは、1970 年 1 月 1 日木曜日の 00:00:00 より後の時点に設定する必要があります。そうでない場合、このパラメーターは無効になります。タイムゾーン関連の問題を防ぐために、UNIX タイムスタンプを使用することを推奨します。	2021-05-08 08:00:00
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 から経過したミリ秒数時間フォーマット：YYYY-MM-DDThh:mm:ssZ 説明タイムゾーン関連の問題を防ぐために、UNIX タイムスタンプを使用することを推奨します。	2021-05-08 10:00:00
Dimensions	string	任意	指定されたリソースのモニタリングディメンションです。値は `key:value` ペアのコレクションに設定します。例：`{"userId":"120886317861**"}` または `{"instanceId":"i-2ze2d6j5uhg20x47**"}`。説明各リクエストで最大 50 個のインスタンスをクエリできます。	[{"instanceId": "i-2ze2d6j5uhg20x47****"}]
Orderby	string	必須	データをソートする基準となるフィールドです。有効値： Average Minimum Maximum	Average
OrderDesc	string	任意	データのソート順です。有効値： True：データを昇順でソートします。 False (デフォルト)：データを降順でソートします。	false
Length	string	任意	1 ページあたりのエントリ数です。デフォルト値：10。説明 1 つのリクエストにおける Length パラメーターの最大値は 1440 です。	10
Express	string	任意	クエリ結果をリアルタイムで計算するために使用される式です。説明 `groupby` 式のみがサポートされています。この式は、データベースで使用される GROUP BY 文に似ています。	{"groupby":["userId","instanceId"]}

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

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	HTTP ステータスコードです。説明状態コード 200 は、リクエストが成功したことを示します。	200
Message	string	エラーメッセージです。	The specified resource is not found.
RequestId	string	リクエスト ID です。	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Datapoints	string	モニタリングデータです。	[{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861**\",\"instanceId\":\"i-j6ccf7d5fn335qpo\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861\",\"instanceId\":\"i-0xii2bvf42iqvxbp**\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]
Period	string	モニタリングデータの統計期間です。単位：秒。有効値：15、60、900、3600。	60

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Datapoints": "[{\\\"order\\\":1,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-j6ccf7d5fn335qpo****\\\",\\\"Average\\\":99.92,\\\"Minimum\\\":99.5,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0},{\\\"order\\\":2,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-0xii2bvf42iqvxbp****\\\",\\\"Average\\\":99.91,\\\"Minimum\\\":99.0,\\\"Maximum\\\":100.0,\\\"_count\\\":1.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.

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

変更履歴

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