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

:DescribeMetricTop

最終更新日:Nov 17, 2025

インスタンスのネットワーク帯域幅などのメトリックの最新のモニタリングデータをクエリし、ソートされたリストで結果を返します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

MetricNames

array

必須

メトリックのリスト。

string

任意

メトリックの名前。

列挙値:

  • instance_out_traffic :

    送信帯域幅 (標準ネットワークのみ)

  • instance_in_traffic :

    受信帯域幅 (標準ネットワークのみ)

instance_in_traffic

AndroidInstanceIds

array

任意

インスタンスレベルのモニタリングでは、クラウドフォンのインスタンス ID のリストを指定します。

string

任意

インスタンスレベルのモニタリングでは、クラウドフォンのインスタンス ID を指定します。

acp-sgicbcdadjs****

Period

integer

任意

モニタリングデータの統計期間。 単位: 秒。

60

StartTime

string

任意

クエリの開始時刻。

2019-01-31 10:00:00

EndTime

string

任意

クエリの終了時刻。

2019-01-31 11:00:00

NextToken

string

任意

次の結果ページの開始を示すトークン。このパラメーターを空のままにすると、クエリは最初から開始されます。

AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****

Length

string

任意

各ページで返すエントリ数。このパラメーターはページ分割されたクエリに使用されます。

説明

メトリックが `instance_in_traffic` または `instance_out_traffic` の場合、最大値は 100 です。

100

InstanceIds

array

任意

インスタンス ID のリスト。

string

任意

インスタンス ID。

説明

帯域幅プラン ID を指定して、プランの上位 N (N は 100 以下) 個の帯域幅データポイントをクエリします。データは帯域幅の降順でソートされます。

np-5hh4a31emkt6u****

レスポンスフィールド

フィールド

説明

object

返されたデータ。

RequestId

string

リクエスト ID。

4610632D-D661-5982-B3D7-5D3FD183F****

Count

integer

返されたエントリ数。

1

NextToken

string

次の結果ページを取得するためのトークン。1 回のクエリで結果が完全に返されない場合、このパラメーターは空ではありません。後続のクエリでこのトークンを使用して、結果の取得を続行できます。

AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****

MetricTotalModel

array<object>

インスタンスのモニタリング結果のリスト。

array<object>

インスタンスのモニタリング結果。

AndroidInstanceId

string

インスタンスレベルのモニタリングでは、これはクラウドフォンのインスタンス ID です。

acp-fkuit0cmyru4p****

InstanceId

string

インスタンス ID。

np-5hh4a31emkt6u****

MetricModelList

array<object>

メトリックのモニタリング結果のリスト。

array<object>

メトリックのモニタリング結果。

MetricName

string

メトリックの名前。

instance_in_traffic

DataPoints

array<object>

モニタリングデータポイント。

object

モニタリングデータポイント。

Timestamp

integer

データポイントのタイムスタンプ。単位: ミリ秒。

1548777660000

Minimum

number

最小値。

説明

メトリックが `instance_in_traffic` または `instance_out_traffic` の場合、単位は bps です。

93.1

Average

number

平均値。単位: %。

説明

メトリックが `instance_in_traffic` または `instance_out_traffic` の場合、単位は bps です。

99.52

Maximum

number

最大値。単位: %。

説明

メトリックが `instance_in_traffic` または `instance_out_traffic` の場合、単位は bps です。

100

Name

string

名前。

cloudPhone-****

Id

string

ID。

acp-fkuit0cmyru4p****

Properties

string

プロパティ。

説明

拡張プロパティを含む JSON 文字列。

{"IP":"192.168.*.***"}

成功レスポンス

JSONJSON

{
  "RequestId": "4610632D-D661-5982-B3D7-5D3FD183F****",
  "Count": 1,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
  "MetricTotalModel": [
    {
      "AndroidInstanceId": "acp-fkuit0cmyru4p****",
      "InstanceId": "np-5hh4a31emkt6u****",
      "MetricModelList": [
        {
          "MetricName": "instance_in_traffic",
          "DataPoints": [
            {
              "Timestamp": 1548777660000,
              "Minimum": 93.1,
              "Average": 99.52,
              "Maximum": 100,
              "Name": "cloudPhone-****",
              "Id": "acp-fkuit0cmyru4p****\n",
              "Properties": "{\"IP\":\"192.168.*.***\"}"
            }
          ]
        }
      ]
    }
  ]
}

エラーコード

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

変更履歴

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