すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeProxyService

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeProxyService

    最終更新日:May 26, 2026

    この API を呼び出すと、OceanBase Database のプロキシサービス情報を照会できます。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    OceanBase クラスターの ID。

    ob317v4uif****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストの結果。

    RequestId

    string

    リクエストの ID。

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    Data

    object

    データリスト。

    ProxyClusterId

    string

    プロキシクラスターの ID。

    proxy-3t****zrieasg
    ProxyMode

    string

    プロキシモード。

    shared
    Zone

    string

    ゾーン。

    cn-shanghai-e,cn-shanghai-f
    UnitSpec

    string

    ユニットの設定。

    4C8GB
    UnitNum

    integer

    テナント内のリソースユニット数。

    1
    CurrentEndpointNum

    integer

    現在のエンドポイント数。

    1
    EndpointNumQuota

    integer

    エンドポイントのクォータ。

    3
    CreateTime

    string

    プロキシクラスターが作成された時刻。

    2023-07-05T08:23:10Z
    Status

    string

    プロキシサービスのステータス。

    ONLINE
    ProxyServiceVersion

    string

    プロキシサービスのバージョン。

    1.0
    ExpireTime

    string

    有効期限。

    2123-07-05T16:00:00
    UnitNumLimit

    integer

    ユニットの最大数。

    4
    ProxyVersion

    string

    データベースプロキシのバージョン。

    4.3.1.0-xxxxxxxxx
    DeployMode

    string

    デプロイメントモード。

    share
    ServerNumLimit

    integer

    ノードの最大数。

    0
    AllowModifyServerNum

    boolean

    ノード数を変更できるかどうかを示します。有効値： true および false。ノード数を変更できる場合は現在のノード数が表示され、変更できない場合は表示されません。

    true
    SharedUnitNumLimit

    integer

    共有モードでの、Kubernetes プロキシサービスの最大ユニット数。

    0
    ExclusiveUnitNumLimit

    integer

    専用モードでの、Kubernetes プロキシサービスの最大ユニット数。

    0

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Data": {
    "ProxyClusterId": "proxy-3t****zrieasg",
    "ProxyMode": "shared",
    "Zone": "cn-shanghai-e,cn-shanghai-f",
    "UnitSpec": "4C8GB",
    "UnitNum": 1,
    "CurrentEndpointNum": 1,
    "EndpointNumQuota": 3,
    "CreateTime": "2023-07-05T08:23:10Z",
    "Status": "ONLINE",
    "ProxyServiceVersion": "1.0",
    "ExpireTime": "2123-07-05T16:00:00",
    "UnitNumLimit": 4,
    "ProxyVersion": "4.3.1.0-xxxxxxxxx",
    "DeployMode": "share",
    "ServerNumLimit": 0,
    "AllowModifyServerNum": true,
    "SharedUnitNumLimit": 0,
    "ExclusiveUnitNumLimit": 0
  }
}

    エラーコード

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

    変更履歴

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