すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeTenantMetrics

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeTenantMetrics

    最終更新日:May 26, 2026

    テナントの監視メトリクスを照会します。
    サポートされているメトリクスの詳細については、「[テナント統計の表示](212125)」をご参照ください。

    今すぐお試しください

    この 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:DescribeTenantMetrics

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    OceanBase クラスターの ID です。

    ob317v4uif****
    PageSize

    integer

    任意

    1 ページに表示するエントリ数です。

    10
    PageNumber

    integer

    任意

    表示するページの番号です。

    1
    TenantName deprecated

    string

    任意

    テナント名です。

    pay_online
    StartTime

    string

    必須

    監視データの開始時刻です。
    この時刻は UTC のみをサポートしており、形式は YYYY-MM-DDThh:mm:ssZ です。

    2021-06-13T15:40:43Z
    EndTime

    string

    必須

    監視データの終了時刻です。
    この時刻は UTC のみをサポートしており、形式は YYYY-MM-DDThh:mm:ssZ です。

    2021-06-13T15:45:43Z
    Metrics

    string

    必須

    照会するメトリクスです。

    tps
    TenantId deprecated

    string

    任意

    テナント ID です。

    説明


    このパラメーターは将来的に非推奨となる予定です。代わりに TenantIdList を使用することを推奨します。

    tfafd34fs****
    TenantIdList

    string

    任意

    テナント ID のリストです。

    [tdak3nac****,tdakc42df****]

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストの結果です。

    TotalCount

    integer

    総数です。

    9
    RequestId

    string

    リクエスト ID です。

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

    string

    テナントのメトリクス情報です。

    "Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 9,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "TenantMetrics": "\"Metrics\":[ {\"request_queue_rt\":0.0,\"TimeStamp\":\"2022-02-23T01:58:00Z\"}]"
}

    エラーコード

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

    変更履歴

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