すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeSupabaseInstanceAttribute

    ドキュメントセンター

    PolarDB:DescribeSupabaseInstanceAttribute

    最終更新日:Sep 18, 2026

    Supabase インスタンスの詳細を照会します。

    操作説明

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardbx:DescribeSupabaseInstanceAttribute

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    DBInstanceName

    string

    必須

    インスタンス名。

    pxsp-*********

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    C457B28E-9CAB-4B77-B5C6-5D71B7870B6E
    Data

    object

    インスタンスの詳細。

    DBInstanceName

    string

    インスタンス名。

    pxc-supabase-001
    Status

    string

    インスタンスステータス。

    Running
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    ZoneId

    string

    ゾーンの ID。

    cn-zhangjiakou-a
    SupabaseClassCode

    string

    Supabase クラスコード。

    polarx.supabase.x4.xlarge
    NodeClass

    string

    ノードスペック。

    polarx.supabase.x2.small
    NodeCount

    integer

    ノードの数。

    1
    VpcId

    string

    VPC の ID。

    vpc-********
    VSwitchId

    string

    vSwitch の ID。

    vsw-********
    CreateTime

    string

    作成時間。

    2025-07-13 10:01:50 +0800
    TopologyType

    string

    トポロジータイプ。

    1aゾーン
    EngineVersion

    string

    データベースエンジンバージョン。

    2.0
    MinorVersion

    string

    マイナーエンジンバージョン。

    polardb-2.6.0_xcluster8.4.21-20260716_pxbaas-20260915
    LockMode

    string

    ロックモード。

    Unlock
    Expired

    boolean

    インスタンスが期限切れかどうかを示します。

    false
    PolarDBXDBInstanceName

    string

    関連付けられた PolarDB-X インスタンスの名前。

    pxc-*********
    ConnAddrs

    array<object>

    エンドポイントのリスト。

    object

    エンドポイント。

    ConnectionString

    string

    エンドポイント。

    pxsp-********.rds.aliyuncs.com
    Port

    integer

    ポート。

    3306
    NetType

    string

    ネットワークタイプ。

    0
    VpcId

    string

    VPC の ID。

    vpc-********
    Nodes

    array<object>

    ノードのリスト。

    object

    ノードの ID。

    Id

    string

    ノードの ID。

    2005777
    Name

    string

    ノードの名前。

    pxsp-********
    ZoneId

    string

    ゾーンの ID。

    cn-hangzhou-a
    ClassCode

    string

    クラスコード。

    polarx.supabase.x2.small
    TenantMode

    boolean

    マルチテナントモード。

    false
    AccessDeniedDetail

    object

    アクセス拒否の詳細。

    AuthAction

    string

    認証操作。

    xxx
    AuthPrincipalType

    string

    認証プリンシパルタイプ。

    222
    NoPermissionType

    string

    権限拒否のタイプ。

    ImplicitDeny
    PolicyType

    string

    ポリシータイプ。

    PRIORITY
    EncodedDiagnosticMessage

    string

    エンコードされた診断メッセージ。

    AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==
    AuthPrincipalOwnerId

    string

    認証プリンシパルのオーナー ID。

    111
    AuthPrincipalDisplayName

    string

    認証プリンシパルの表示名。

    xxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
  "Data": {
    "DBInstanceName": "pxc-supabase-001",
    "Status": "Running",
    "RegionId": "cn-hangzhou",
    "ZoneId": "cn-zhangjiakou-a",
    "SupabaseClassCode": "polarx.supabase.x4.xlarge",
    "NodeClass": "polarx.supabase.x2.small",
    "NodeCount": 1,
    "VpcId": "vpc-********",
    "VSwitchId": "vsw-********",
    "CreateTime": "2025-07-13 10:01:50 +0800",
    "TopologyType": "1azone",
    "EngineVersion": "2.0",
    "MinorVersion": "polardb-2.6.0_xcluster8.4.21-20260716_pxbaas-20260915",
    "LockMode": "Unlock",
    "Expired": false,
    "PolarDBXDBInstanceName": "pxc-*********",
    "ConnAddrs": [
      {
        "ConnectionString": "pxsp-********.rds.aliyuncs.com",
        "Port": 3306,
        "NetType": "0",
        "VpcId": "vpc-********"
      }
    ],
    "Nodes": [
      {
        "Id": "2005777",
        "Name": "pxsp-********",
        "ZoneId": "cn-hangzhou-a",
        "ClassCode": "polarx.supabase.x2.small"
      }
    ],
    "TenantMode": false
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "PRIORITY",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx"
  }
}

    エラーコード

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

    変更履歴

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