全部產品
Search
文件中心

PolarDB:DescribeOpenSearchInstances

更新時間:Sep 10, 2026

查詢 PolarDBX Search 執行個體清單。

介面說明

該介面用於獲取使用者已設定的自訂終端節點(Endpoint)清單,便於管理和檢視私有連線或 VPC 終端服務的設定。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

執行個體所屬的地域 ID。

cn-hangzhou

DBInstanceName

string

否

執行個體名稱。

pxc-spsil01pww4hfz

PageNumber

integer

否

頁碼。

1

PageSize

integer

否

頁面大小。

1

MaxResults

integer

否

分頁查詢時每頁列數。最大值為 100。預設值:當不設定值或設定的值小於 10 時,預設值為 10。當設定的值大於 100 時,預設值為 100。

1000

NextToken

string

否

下一個查詢開始 Token。

xxdds

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

A501A191-BD70-5E50-98A9-C2A486A82****

Data

object

操作結果。

Instances

array<object>

叢集 ID。

object

叢集 ID。

AvailabilityZone

string

可用區。

t1222576965886205

ChargeType

string

付費類型,返回值:

  • PrePaid:預付費。

  • PostPaid:按量付費。

PostPaid

Cpu

integer

CPU 數量。

4000

CreateTime

string

建立時間。

2026-06-08T07:19:05.000+0000

DataNodeCount

integer

資料節點數量。

3

Description

string

執行個體描述。

我的 Supabase 專案

EngineVersion

string

引擎版本,預設 2.0。

8.0

InstanceId

string

執行個體 ID。

pxc-shrdb7a2t8w3c1

NetType

string

連接字串網路類型,取值範圍如下:

  • Public:公網地址。

  • Private:私網地址。

  • Inner:私網地址(傳統網路)。

1

RegionId

string

地域 ID。

cn-beijing

SpecDisplay

string

執行個體規格顯示名稱。

8 核 32 GB

Status

string

執行個體狀態。

RUNNING

MemoryGB

integer

設定的記憶體大小,單位為 GB。

16

StorageSizeGB

integer

單一資料節點的儲存空間大小,單位為 GB。

500

PageNumber

integer

頁面索引。

1

PageSize

integer

頁面大小。

30

TotalNumber

integer

總數。

130

MaxResults

integer

分頁查詢時每頁列數。最大值為 100。預設值:當不設定值或設定的值小於 10 時,預設值為 10。當設定的值大於 100 時,預設值為 100。

10

NextToken

string

下一個查詢開始 Token。

AAAAAV3MpHK1AP0pfERHZN5pu6kmMV9kamx92yNWehxph5Fw

AccessDeniedDetail

object

無權限存取詳情。

AuthAction

string

鑑權動作。

xxx

AuthPrincipalType

string

鑑權主體類型。

222

AuthPrincipalOwnerId

string

鑑權主體 OwnerId。

111

AuthPrincipalDisplayName

string

鑑權主體名稱。

xxx

PolicyType

string

策略類型。

PRIORITY

NoPermissionType

string

無權限類型。

ImplicitDeny

EncodedDiagnosticMessage

string

診斷資訊。

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "Instances": [
      {
        "AvailabilityZone": "t1222576965886205",
        "ChargeType": "PostPaid",
        "Cpu": 4000,
        "CreateTime": "2026-06-08T07:19:05.000+0000",
        "DataNodeCount": 3,
        "Description": "我的 Supabase 项目",
        "EngineVersion": "8.0",
        "InstanceId": "pxc-shrdb7a2t8w3c1",
        "NetType": "1",
        "RegionId": "cn-beijing",
        "SpecDisplay": "8 核 32 GB",
        "Status": "RUNNING",
        "MemoryGB": 16,
        "StorageSizeGB": 500
      }
    ],
    "PageNumber": 1,
    "PageSize": 30,
    "TotalNumber": 130,
    "MaxResults": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kmMV9kamx92yNWehxph5Fw"
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。