DescribeMetricsDataV2 - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

このオペレーションを呼び出して、メトリクスデータを取得します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	OceanBase クラスターの ID。	ob317v4uif****
Metrics	string	必須	メトリクス。複数のメトリクスはカンマ (,) で区切ります。例：`"sql_all_count,sql_all_rt..."`。	sql_all_rt
StartTime	string	必須	開始時刻。`YYYY-MM-DDThh:mm:ssZ` フォーマットです。	2023-04-12T04:38:38Z
EndTime	string	必須	終了時刻。`YYYY-MM-DDThh:mm:ssZ` フォーマットです。	2023-04-12T05:38:38Z
Labels	string	必須	キーと値のペアをカンマ (,) で区切った文字列。各キーと値はコロン (:) で区切ります。1 つのキーに複数の値がある場合は、セミコロン (;) で区切ります。例：`"clusterId:ob***,tenantId:t**;t***,serverId:***,zoneId:cn-hangzhou-j"`。文字列には、以下の固定キーのみを含めることができます： clusterId：OceanBase クラスターの ID。 tenantId：OceanBase データベーステナントの ID。 zoneId：ゾーンの ID。 serverId：OBServer ノードの ID。	clusterId:ob***
GroupByLabels	string	必須	グループ化に使用する1つ以上のキー。複数のキーはカンマ (,) で区切ります。例：`"clusterId,tenantId"`。	clusterId
SortMetricKey	string	任意	ソート列。	tps
SortOrder	string	任意	ソート順。有効値： ASC：昇順 DESC：降順	DESC
Limit	string	任意	ソート後に返されるデータ配列の長さ。	20
ReplicaType	string	任意	レプリカのタイプ。OceanBase クラスターのモニタリングデータをクエリする際に、レプリカタイプに基づいてノードのフィルタリング条件が設定されます。デフォルトでは、OceanBase クラスターまたはアクセスプロキシのモニタリングデータをクエリする際に、レプリカタイプは指定されません。OceanBase クラスターのモニタリングデータをクエリする際にレプリカタイプを指定しない場合、すべてのノードのモニタリングデータがクエリされます。 OceanBase クラスターのモニタリングデータをクエリする際にレプリカタイプを`FULL`に設定すると、フル機能レプリカノードのモニタリングデータのみがクエリされます。 OceanBase クラスターのモニタリングデータをクエリする際にレプリカタイプを`READONLY`に設定すると、読み取り専用レプリカノードのモニタリングデータのみがクエリされます。	FULL

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストの結果。
RequestId	string	リクエストの ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array<object>	返されたデータ。
	array<object>	返されたデータ。
Labels	object	データラベル。
	string	ラベルの詳細。	clusterId:ob********
Data	array<object>	返されたデータ。
	array<object>	返されたデータ。
MetricValue	object	メトリクスデータ。
	string	メトリクスデータ。	'load1': 1.29
Timestamp	integer	タイムスタンプ。	1702434300

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "Labels": {
        "key": "clusterId:ob********"
      },
      "Data": [
        {
          "MetricValue": {
            "key": "'load1': 1.29"
          },
          "Timestamp": 1702434300
        }
      ]
    }
  ]
}

エラーコード

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

変更履歴

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