BatchExport によるモニタリングデータのエクスポート - CMS - Alibaba Cloud - Cloud Monitor

Cursor操作で定義された監視データをエクスポートするために、BatchExport操作を呼び出します。

操作説明

前提条件

Cursor 操作を呼び出して、初期Cursorを取得していることを確認してください。

使用上の注意

このトピックでは、クラウドサービスacs_ecs_dashboardのメトリクスcpu_idleの初期Cursorの監視データをエクスポートする方法を示す例を提供します。1 回の呼び出しで最大 1,000 件のデータエントリが返されます。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Namespace	string	必須	クラウドサービスのデータ名前空間。クラウドサービスのデータ名前空間の取得方法については、付録 1: メトリクスをご参照ください。説明このパラメーターは、Cursor 操作のリクエストパラメーター`Namespace`と同じである必要があります。	acs_ecs_dashboard
Metric	string	必須	クラウドサービスのメトリクスの名前。クラウドサービスのメトリクス名の取得方法については、付録 1: メトリクスをご参照ください。説明このパラメーターは、Cursor 操作のリクエストパラメーター`Metric`と同じである必要があります。	cpu_idle
Cursor	string	必須	データをエクスポートするためにこの操作をループで呼び出す場合、`Cursor`の値を指定する必要があります。`Cursor`の値は、次の方法で取得できます。この操作を初めて呼び出す場合は、まずCursor 操作を呼び出して`Cursor`の値を取得する必要があります。詳細については、 Cursor をご参照ください。この操作を再度呼び出す場合は、前回の呼び出しのレスポンスから`Cursor`の値を取得できます。	eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****
Length	integer	必須	1 回ごとに返されるデータエントリの最大数。有効値: 1～10000。	1000
Measurements	array	任意	返されるデータをカスタマイズするために使用される測定値。デフォルトでは、すべての測定値が返されます。たとえば、クラウドサービス`acs_ecs_dashboard`のメトリクス`cpu_idle`には、`Average`、`Maximum`、`Minimum`の3つの測定値カラムがあります。`Average`と`Maximum`のカラムのみを返す必要がある場合は、このパラメーターを配列`["Average", "Maximum"]`に設定します。クラウドサービスのメトリクスの測定値の取得方法については、付録 1: メトリクスの`statistics`カラムをご参照ください。
	string	任意	測定値のカラム名。	Maximum

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

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
Message	string	返されたメッセージ。	success
Code	integer	ステータスコード。説明値 200は成功を示します。	200
Success	boolean	操作が成功したかどうかを示します。有効値: true: 成功 false: 失敗	true
RequestId	string	リクエストID。	251402CD-305C-1617-808E-D8C11FC8138D
Cursor	string	この操作を再度呼び出すために使用されるカーソル。説明返された結果が`null`の場合、監視データはエクスポート済みです。	v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***
Length	integer	この呼び出しで返されたデータエントリの数。	1000
Anchor	integer	バックエンドがデータをリクエストしたときのタイムスタンプ。タイムスタンプが大きいほど、エクスポートされたデータが現在時刻に近いことを示します。	1678781819000
HasNext	boolean	データがエクスポートされたかどうかを示します。有効値: true: 一部のデータがエクスポートされていません。 false: すべてのデータがエクスポートされました。	true
DataResults	array	この呼び出しで返されたデータ。
	MetricStat	エクスポートされたデータ。詳細は次のとおりです。 Namespace: クラウドサービスのデータ名前空間。例: `acs_ecs_dashboard`。 Metric: クラウドサービスのメトリクスの名前。例: `cpu_idle`。 Timestamp: 監視データのタイムスタンプ。単位: ミリ秒。例: 1641454680000。 Period: 監視データの統計期間。単位: 秒。例: 60。 Dimensions: 監視対象のオブジェクト(インスタンス)を識別するために使用されるディメンション情報。例: `[{"Label":"userId", "Value":""20654616023382**"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4"}]`。 Associated: タグ情報など、監視対象のオブジェクト(インスタンス)に関する追加情報。値はkey:valueペアのコレクションです。例: `{"group":"test**", "name":"Alice"}`。 Measurements: メトリクスの測定値(デフォルトでマルチバリューモード)。例: `{"Average":60,"Maximum":85}`。 LogTime: 監視データの記録時刻。単位: ミリ秒。非生データ(集計データ)の場合、`LogTime`は空(NULL)です。

例

成功レスポンス

JSONJSON

{
  "Message": "success",
  "Code": 200,
  "Success": true,
  "RequestId": "251402CD-305C-1617-808E-D8C11FC8138D",
  "Cursor": "v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***",
  "Length": 1000,
  "Anchor": 1678781819000,
  "HasNext": true,
  "DataResults": [
    {
      "Namespace": "acs_ecs_dashboard",
      "Metric": "cpu_idle",
      "Period": 60,
      "Timestamp": 1641454680000,
      "Dimensions": [
        {
          "Label": "instanceId",
          "Value": "i-dferwret*****"
        }
      ],
      "Associated": {
        "key": "{\"group\":\"test****\", \"name\":\"Alice\"}"
      },
      "Measurements": {
        "key": "{\"Average\":60,\"Maximum\":85}"
      },
      "LogTime": 1683686550073
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
500	%s	%s
403	%s	%s
404	%s	%s
503	%s	%s

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

変更履歴

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