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

ApsaraDB for OceanBase (Deprecated):DescribeNodeMetrics

最終更新日:May 26, 2026

このオペレーションを呼び出して、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:DescribeNodeMetrics

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

OceanBase クラスターインスタンスの ID。

ob317v4uif****

PageSize

integer

任意

1 ページあたりのエントリ数。

10

PageNumber

integer

任意

ページ番号。

1

TenantId

string

任意

テナントの ID。

tfafd34fs****

StartTime

string

必須

照会する時間範囲の開始時刻。UTC 形式です。

2021-06-13T15:40:43Z

EndTime

string

必須

照会する時間範囲の終了時刻。UTC 形式です。

2021-09-13T15:40:43Z

Metrics

string

必須

照会するメトリクス。

tps

NodeName

string

任意

ノード名。

i-bp16niirq4zdmgvm****

NodeIdList

string

任意

ノード ID のリスト。文字列の JSON 配列です。

[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]

レスポンスフィールド

フィールド

説明

object

TotalCount

integer

http(s)://[Endpoint]/?Action=DescribeNodeMetrics
&InstanceId=ob317v4uif****
&PageSize=10
&PageNumber=1
&TenantId=ob2mr3oae0****
&StartTime=2021-06-13 15:40:43
&EndTime=2021-09-13 15:40:43
&Metrics=tps
&NodeName=i-bp16niirq4zdmgvm****
&NodeIdList=["i-bp19y05uq6xpacyqnlrc","i-bp1blcr3htr3g3u2vqvu","i-bp1392ikhayhr3hi4fli"]
&共通リクエストパラメーター

9

RequestId

string

リクエストの一意の ID。

EE205C00-30E4-****-****-87E3A8A2AA0C

NodeMetrics

string

ノードメトリクスのリスト。

-

成功レスポンス

JSONJSON

{
  "TotalCount": 9,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "NodeMetrics": "-"
}

エラーコード

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

変更履歴

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