DescribeMetricLast を使用した最新監視データのクエリ - CMS - Alibaba Cloud - Cloud Monitor

操作説明

事前準備

DescribeMetricLast、DescribeMetricList、DescribeMetricData、および DescribeMetricTop の呼び出しは、合計で月間 1,000,000 回の無料クォータを共有します。無料クォータを使い切った後、CloudMonitor Basic の従量課金方法を有効にしていない場合、この API を正常に使用できません。CloudMonitor Basic の従量課金方法を有効にしている場合、無料クォータを使い切った後も API は引き続き機能し、無料クォータを超えた使用量は自動的に課金されます。従量課金を有効にする方法については、「従量課金の有効化」をご参照ください。
単一の API オペレーションのレート制限は、1 秒あたり 50 回の呼び出しです。この制限は、Alibaba Cloud アカウントとそのアカウント配下のすべての Resource Access Management (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 日間です。

操作の説明

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

今すぐお試しください

この 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:QueryMetricLast

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Namespace	string	必須	クラウドサービスの名前空間。クラウドサービスの名前空間の詳細については、「クラウドサービスの監視メトリクス」をご参照ください。	acs_ecs_dashboard。
MetricName	string	必須	クラウドサービスのメトリック名。メトリック名の詳細については、「クラウドサービスの監視メトリクス」をご参照ください。	CPUUtilization。
Period	string	任意	モニタリングデータの統計期間。有効な値: 15、60、900、3600。単位: 秒。説明統計期間を設定しない場合、モニタリングデータはメトリックの登録時に指定されたレポート期間に基づいて照会されます。 - 統計期間は、各クラウドサービスのメトリック (`MetricName`) によって異なります。詳細については、「クラウドサービスの監視メトリクス」の対象となるクラウドサービスのメトリックリストページにある `Min Periods` 列をご参照ください。	60
StartTime	string	任意	開始時刻。 2 つのフォーマットがサポートされています。1. ミリ秒 (ms) 単位の UNIX タイムスタンプ文字列。1970-01-01 00:00:00 UTC からの経過ミリ秒数を表します。2. UTC の YYYY-MM-DDThh:mm:ssZ フォーマットの ISO 8601 形式の時間文字列。説明クエリの有効値は左開右閉区間を使用します。StartTime は EndTime 以上にはできず、両者の間隔は 31 日以下である必要があります。	2019-01-31 10:00:00
EndTime	string	任意	メトリックを照会する終了時刻。システムはデータ粒度に基づいてクエリの開始時刻 (クエリウィンドウサイズ) を自動的に制限します。秒レベルのデータ: 最大クエリスパンは 20 分です (開始時刻 = Max(startTime, EndTime - 20min))。分レベルのデータ: 最大クエリスパンは 2 時間です (開始時刻 = Max(startTime, EndTime - 2h))。時間レベルのデータ: 最大クエリスパンは 2 日間です (開始時刻 = Max(startTime, EndTime - 2d))。説明指定された startTime が制限より前の場合、システムは自動的に制限を実際のクエリ開始時刻として使用します。	2019-01-31 10:10:00
Dimensions	string	任意	指定されたリソースのモニタリングディメンション。フォーマット: `キー:値` ペアのコレクション。例: `{"userId":"120886317861**"}` または `{"instanceId":"i-2ze2d6j5uhg20x47**"}`。説明 1 回のリクエストで最大 50 個のインスタンスを照会できます。	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
NextToken	string	任意	ページングカーソル。フィルター条件に一致するクエリ結果がページサイズを超える場合、ページングカーソルが返されます。次のページのデータを取得するには、返されたカーソル値をリクエストパラメーターとして使用します。カーソル値が返されなくなるまで繰り返すと、すべてのデータが取得されたことを示します。	15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
Length	string	任意	モニタリングデータの 1 ページあたりのエントリ数。このパラメーターはページングクエリに使用されます。デフォルト値: 1000。1 ページあたり 1000 エントリのモニタリングデータを示します。説明 1 回のリクエストにおける Length の最大値は 1440 です。	1000
Express	string	任意	既存のクエリ結果に対するリアルタイム計算の式。	{"groupby":["userId","instanceId"]}

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

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	ページングカーソル。	xxxxxx。
RequestId	string	リクエスト ID。	021472A6-25E3-4094-8D00-BA4B6A5486C3
Success	boolean	操作が成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true。
Datapoints	string	モニタリングデータのリスト。	[{"timestamp":1548777660000,"userId":"123456789876**","instanceId":"i-abcdefgh12**","Minimum":93.1,"Average":99.52,"Maximum":100}]
Code	string	状態コード。説明値が 200 の場合は成功を示します。	200
Message	string	エラーメッセージ。	The specified resource is not found.
Period	string	時間間隔。単位: 秒。	60

例

成功レスポンス

JSONJSON

{
  "NextToken": "xxxxxx",
  "RequestId": "021472A6-25E3-4094-8D00-BA4B6A5486C3",
  "Success": true,
  "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"123456789876****\",\"instanceId\":\"i-abcdefgh12****\",\"Minimum\":93.1,\"Average\":99.52,\"Maximum\":100}]",
  "Code": "200",
  "Message": "The specified resource is not found.",
  "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.

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

変更履歴

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