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

この API は、OceanBase クラスターの単一または多次元の監視メトリクスを取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeMetricsData

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	OceanBase クラスターの ID です。	ob317v4uif****
StartTime	string	必須	クエリの開始時刻です。時刻は UTC で、YYYY-MM-DDThh:mm:ssZ 形式で指定する必要があります。	2021-06-13T15:40:43Z
EndTime	string	必須	クエリの終了時刻です。時刻は UTC で、YYYY-MM-DDThh:mm:ssZ 形式で指定する必要があります。	2021-06-13T15:40:43Z
Metrics	string	必須	クエリする監視メトリクスです。複数のメトリクスはカンマ (,) で区切ります。例：「sql_all_count,sql_all_rt...」	sql_all_count
Labels	string	必須	キーと値のペアの文字列です。キーと値はコロン (:) で区切り、キーと値のペアはカンマ (,) で区切ります。例：「app:OB,clusterId:ob***,tenantId:t**,serverId:***,zoneId:cn-hangzhou-j」サポートされるキーは次のとおりです。 app：アプリケーションタイプです。現在、OceanBase のみがサポートされています。 clusterId： OceanBase クラスターの ID です。 tenantId： OceanBase テナントの ID です。 zoneId： OceanBase ゾーンの ID です。 serverId： OBServer ノードの ID です。	app:OB,clusterId:ob***
GroupByLabels	string	必須	結果をグループ化するためのフィールドです。複数のフィールドはカンマ (,) で区切ります。例：「app,clusterId,tenantId」	app,clusterId
SortMetricKey	string	任意	結果をソートするためのメトリクスキーです。	tps
SortOrder	string	任意	ソート順です。 ASC：昇順。 DESC：降順。	DESC
Limit	string	任意	返されるアイテム数の上限です。	5
ReplicaType	string	任意	レプリカタイプです。 OceanBase クラスターの監視では、このパラメーターでレプリカタイプに基づいてノードを絞り込みます。デフォルト (未指定)：すべてのレプリカタイプの監視データを取得します。これは OceanBase とアクセスプロキシの監視の両方に適用されます。 FULL：フル機能レプリカノードのみの監視データを取得します。この値は OceanBase の監視でのみ有効です。 READONLY：読み取り専用レプリカノードのみの監視データを取得します。この値は OceanBase の監視でのみ有効です。	FULL

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスです。
RequestId	string	リクエスト ID です。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array	監視データを含む JSON 形式の文字列の配列です。	[ { "sql_select_count":75.**151515, "timestamp":165079** }, ...... ]
	string	データポイントを含む JSON 形式の文字列です。	[{'clusterId': 'ob5b8*******', 'Data': [{'timestamp': 1702434300, 'sql_all_rt': 0.64}, {'timestamp': 1702434240, 'sql_all_rt': 0.0}], 'tenantId': 't5b8*******'}]

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    "[{'clusterId': 'ob5b8*********', 'Data': [{'timestamp': 1702434300, 'sql_all_rt': 0.64}, {'timestamp': 1702434240, 'sql_all_rt': 0.0}], 'tenantId': 't5b8*********'}]"
  ]
}

エラーコード

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

変更履歴

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