DescribeMetricList 操作は、クラウドサービスの特定のメトリックのモニタリングデータをクエリするために使用されます。
操作説明
DescribeMetricLast、DescribeMetricList、DescribeMetricData、および DescribeMetricTop 操作には、1 か月あたり合計 100 万回の API 呼び出しの無料クォータがあります。無料クォータを使い切り、CloudMonitor Basic の従量課金方法を有効にしていない場合、これらの API 操作は使用できなくなります。従量課金方法を有効にしている場合は、無料クォータを使い切った後も 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 です。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Namespace |
string |
必須 |
クラウドサービスの名前空間。 詳細については、「メトリック」をご参照ください。 |
acs_ecs_dashboard |
| MetricName |
string |
必須 |
メトリックの名前。 詳細については、「メトリック」をご参照ください。 |
cpu_idle |
| Period |
string |
任意 |
モニタリングデータの統計期間。 有効値:15、60、900、3600。 単位:秒。 説明
|
60 |
| StartTime |
string |
任意 |
クエリする時間範囲の開始時刻。次のフォーマットがサポートされています:
説明
|
2019-01-30 00:00:00 |
| EndTime |
string |
任意 |
クエリする時間範囲の終了時刻。次のフォーマットがサポートされています:
説明
`StartTime` と `EndTime` の間隔は 31 日以下でなければなりません。 |
2019-01-30 00:10:00 |
| Dimensions |
string |
任意 |
モニタリング対象のリソースを指定するディメンション。 フォーマット:キーと値のペアのコレクション。例: 説明
1 回のリクエストで最大 50 個のインスタンスをクエリできます。 |
[{"instanceId":"i-2ze2d6j5uhg20x47****"}] |
| NextToken |
string |
任意 |
ページネーションカーソル。 説明
このパラメーターを設定しない場合、データの最初のページが返されます。このパラメーターに値が返された場合、さらにデータがあることを示します。次のページを取得するには、返された値を次のリクエストの `NextToken` として使用します。null 値は、すべてのデータが取得されたことを示します。 |
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 |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。