すべてのプロダクト
Search
ドキュメントセンター

Elastic Compute Service:DescribeMetricData

最終更新日:Aug 18, 2025

リソースのモニタリングメトリックをクエリします。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

MetricName

string

必須

メトリックの名前。有効な値:

  • disk_bps_percent

  • disk_iops_percent

  • disk_read_block_size

  • disk_read_bps

  • disk_read_iops

  • disk_write_block_size

  • disk_write_bps

  • disk_write_iops

disk_bps_percent

StartTime

string

任意

メトリックデータをクエリする時間範囲の開始時刻。開始時刻は現在時刻の最大 30 日前まで指定できます。 StartTime パラメータと EndTime パラメータの両方を空のままにした場合、システムは最新期間のメトリックをクエリします。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式である必要があります。時刻は UTC で表示されます。

2023-11-21T01:50:00Z

EndTime

string

任意

メトリックデータをクエリする時間範囲の終了時刻。時刻は現在時刻より後にすることはできません。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式である必要があります。時刻は UTC で表示されます。

2023-11-21T02:00:00Z

Period

integer

任意

メトリックデータをクエリする間隔。単位:秒。デフォルト値は 5 です。有効な値:

  • 5:5 秒精度。12 時間の時間範囲内のデータをクエリできます。

  • 10:10 秒精度。24 時間の時間範囲内のデータをクエリできます。

  • 60:60 秒精度。7 日間の時間範囲内のデータをクエリできます。

  • 300:300 秒精度。30 日間の時間範囲内のデータをクエリできます。

  • 600:600 秒精度。30 日間の時間範囲内のデータをクエリできます。

  • 3600:3600 秒精度。30 日間の時間範囲内のデータをクエリできます。

60

Dimensions

string

任意

JSON 形式のディメンションのマップ。マップは、クエリするディメンションを指定します。以下のキーがサポートされています。

  • DiskId:ディスク名。例:d-xxx。

  • DeviceType:ディスクカテゴリ。 `system` はシステムディスクを、 `data` はデータディスクを示します。

  • DeviceCategory:ディスクタイプ。例:cloud_essd。

  • EcsInstanceId:ディスクが接続されている ECS インスタンスの名前。例:i-xxx。

  • Azone:ゾーン。例:cn-hangzhou-a。

返される結果は、指定されたすべてのディメンションベースのフィルタ条件の積集合です。

{"DiskId":["d-bp14xxxx","d-bp11xxxx"], "DeviceCategory": ["cloud_essd"]}

RegionId

string

任意

リージョン ID。

cn-shanghai

AggreOps

string

任意

時間経過に伴うデータの集約方法。有効な値:

  • SUM_OVER_TIME

  • COUNT_OVER_TIME

  • AVG_OVER_TIME

  • MAX_OVER_TIME

  • MIN_OVER_TIME

  • SUM_OVER_TIME_LCRO:左閉右開区間における値の合計。

  • AVG_OVER_TIME_LCRO:左閉右開区間における値の平均。

  • SUM_OVER_TIME_LORC:左開右閉区間における値の合計。

  • AVG_OVER_TIME_LORC:左開右閉区間における値の平均。

AVG_OVER_TIME

AggreOverLineOps

string

任意

異なる行にわたるデータの集約方法。有効な値:

  • NON:集約は実行されません。

  • SUM:値の合計。

  • AVG:値の平均。

  • COUNT:値の数。

  • MAX:最大値。

  • MIN:最小値。

NON

GroupByLabels

array

任意

グループ化と集約のためのフィールドのリスト。

string

任意

グループ化のためのフィールド。以下のフィールドがサポートされています。

  • DiskId:ディスク名。例:d-xxx。

  • DeviceType:ディスクカテゴリ。 `system` はシステムディスクを、 `data` はデータディスクを示します。

  • DeviceCategory:ディスクタイプ。例:cloud_essd。

  • EcsInstanceId:ディスクが接続されている ECS インスタンスの名前。例:i-xxx。

  • Azone:ゾーン。例:cn-hangzhou-a。

DeviceType

レスポンスパラメーター

パラメーター

タイプ

説明

object

DescribeMetricDataResponse

TotalCount

integer

返されたデータエントリの総数。

1

DataList

array<object>

ディスクのモニタリングデータのコレクション。

object

返されたデータのリスト。

Labels

any

ラベル。

{"DiskId": "d-1234"}

Datapoints

any

モニタリングデータのリスト。リストには、一連の連続した秒レベルのタイムスタンプと対応するメトリック値が含まれています。

{"1699258861": 1,"1699259461": 0}

RequestId

string

リクエスト ID。

11B55F58-D3A4-4A9B-9596-342420D0****

Warnings

array

警告メッセージのリスト。

string

警告メッセージ。

not complete.

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "DataList": [
    {
      "Labels": "{\"DiskId\": \"d-1234\"}",
      "Datapoints": "{\"1699258861\": 1,\"1699259461\": 0}"
    }
  ],
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****",
  "Warnings": [
    "not complete."
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter The parameter %s is invalid.
400 InvalidParameter.Conflict The specified parameter %s and %s are not blank at the same time.
400 InvalidParameter.Format Specified parameter format is not valid. 日文说明
400 MissingParameter The input parameter %s that is mandatory for processing this request is not supplied.
500 InternalError The request processing has failed due to some unknown error, exception or failure.
403 Forbidden User is not authorized to operate.
403 Forbidden.Action User is not authorized to operate this action.
403 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance.
403 LastTokenProcessing The last token request is processing.
403 NoPermission.SLR The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403 OperationDenied The operation is not allowed.
404 InvalidApi.NotFound Specified api is not found, please check your url and method.
404 NoSuchResource The specified resource does not exist.
504 RequestTimeout The request is timeout, please try again later.
429 BLOCK.LimitedRequest Request was denied due to user flow control.

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

変更履歴

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