全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeOpenSearchTopology - 查询 PolarDBX Search 集群节点拓扑

更新时间:Sep 10, 2026

查询PolarDBX Search集群节点拓扑

接口说明

  • binlog 文件默认保存 15 天。

  • 返回的日志列表中包含日志记录结束时间在查询开始时间之后,并且日志记录开始时间在查询结束时间之前的所有日志。

  • 当 DownloadLink 不为 NULL 时,用户可以根据此 URL 下载备份文件,此 URL 自生成后 2 天内有效,请在过期时间之前下载。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

DBInstanceName

string

实例 ID。

pxsp-*********

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

9B2F3840-5C98-475C-B269-2D5C3A31797C

Data

object

数据结构体。

Nodes

array<object>

节点 ID。

object

节点 ID。

AvailabilityZone

string

可用区。

t1222576965886205

Cpu

integer

集群总 CPU,单位:核数。

0.25

Host

string

您在 DCDN 控制台上配置的源站域名,包括 IPv4 地址、IPv6 地址、普通域名、OSS 域名。

https://secnet-defense-vastip.oss-cn-hangzhou.aliyuncs.com

IsLeader

boolean

当前节点是否为主节点。

NodeId

string

节点 id

pxc-c-jf0pivh2dt

Role

string

RDS 三节点中某个节点的角色,取值如下:

  • leader:主节点

  • follower:从节点

  • logger:日志节点

polarx_cn

Status

string

节点状态:

  • 0:运行中

  • 1:创建中

  • 2:异常

  • 3:已过期

  • 4:释放中

  • 5:已释放

  • 6:锁定

enabled

MemoryGB

integer

设置的内存数量。

32

Storage

object

实例存储自动扩容功能配置信息。

ReplicaCount

integer

主可用区的备节点数(个)。

说明

ReplicaCountSlaveReplicaCount 参数仅适用于云原生版实例。如果实例为集群架构,则上述参数分别表示单分片的(主、备可用区)备节点数。

1

StorageType

string

存储类型

cloud_auto

StorageTotalGB

integer

节点存储空间总容量,单位为 GB。

500

AccessDeniedDetail

object

无权限访问详情

AuthAction

string

鉴权动作

xxx

AuthPrincipalType

string

说明如上。

222

AuthPrincipalOwnerId

string

鉴权主体 OwnerId

111

AuthPrincipalDisplayName

string

鉴权主体名称

xxx

PolicyType

string

策略类型

PRIORITY

NoPermissionType

string

NoPermissionType

ImplicitDeny

EncodedDiagnosticMessage

string

诊断信息

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

示例

正常返回示例

JSON格式

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "Nodes": [
      {
        "AvailabilityZone": "t1222576965886205",
        "Cpu": 0.25,
        "Host": "https://secnet-defense-vastip.oss-cn-hangzhou.aliyuncs.com",
        "IsLeader": true,
        "NodeId": "pxc-c-jf0pivh2dt",
        "Role": "polarx_cn",
        "Status": "enabled",
        "MemoryGB": 32
      }
    ],
    "Storage": {
      "ReplicaCount": 1,
      "StorageType": "cloud_auto",
      "StorageTotalGB": 500
    }
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情