すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeInstanceSummary

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeInstanceSummary

    最終更新日: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:DescribeInstanceSummary

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageSize

    integer

    任意

    1 ページあたりに返す行数。

    • 最大値：100

    • デフォルト値：10

    10
    PageNumber

    integer

    任意

    取得するページの番号。

    • 開始値：1

    • デフォルト値：1

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストの返却結果。

    RequestId

    string

    リクエスト ID 。

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    InstanceSummary

    object

    OceanBase インスタンスの概要情報。

    TotalInstancesCount

    integer

    インスタンスの総数。

    3
    OverLoadInstancesCount

    integer

    過負荷状態のインスタンス数。

    1
    ImmediatelyExpiredInstancesCount

    integer

    解放対象となった期限切れインスタンスの総数。

    1
    RunningInstancesCount

    integer

    実行中のインスタンス数。

    1
    InsufficientDiskInstancesCount

    integer

    容量リスクのあるクラスターの総数。

    2
    ExpiredInstancesCount

    integer

    期限切れのインスタンス数。

    1
    AlarmSummaryCount

    integer

    クエリ期間中のアラートの総数。

    1
    AnomalySQLCount

    integer

    異常な SQL ステートメントの総数。

    1
    ClusterInstancesCount

    integer

    クラスターインスタンス数。

    1
    TenantInstancesCount

    integer

    テナントインスタンス数。

    1
    TotalOmsInstancesCount

    integer

    データ転送インスタンス数。

    1
    RegionalInstanceSummaryList

    array<object>

    リージョン別インスタンスのリスト。

    object

    Region

    string

    リージョンの ID 。

    cn-shanghai
    TotalInstancesCount

    integer

    インスタンスの総数。

    3
    ImmediatelyExpiredInstancesCount

    integer

    まもなく期限切れとなるインスタンス数。

    1
    RunningInstancesCount

    integer

    実行中のインスタンスの総数。

    1
    ExpiredInstancesCount

    integer

    期限切れのインスタンス数。

    1
    RecentCreatedInstancesCount

    integer

    最近作成されたインスタンス数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "InstanceSummary": {
    "TotalInstancesCount": 3,
    "OverLoadInstancesCount": 1,
    "ImmediatelyExpiredInstancesCount": 1,
    "RunningInstancesCount": 1,
    "InsufficientDiskInstancesCount": 2,
    "ExpiredInstancesCount": 1,
    "AlarmSummaryCount": 1,
    "AnomalySQLCount": 1,
    "ClusterInstancesCount": 1,
    "TenantInstancesCount": 1,
    "TotalOmsInstancesCount": 1,
    "RegionalInstanceSummaryList": [
      {
        "Region": "cn-shanghai",
        "TotalInstancesCount": 3,
        "ImmediatelyExpiredInstancesCount": 1,
        "RunningInstancesCount": 1,
        "ExpiredInstancesCount": 1,
        "RecentCreatedInstancesCount": 1
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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