AI 助理
备案控制台
官方文档
输入文档关键字查找
首页

DescribeDBClusterAttribute - 查看PolarDB集群的详细属性

更新时间：
产品详情
我的收藏

查看集群属性信息。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeDBClusterAttribute

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

 无 无

请求参数

名称

类型

必填

描述

示例值
DBClusterId

string

是

集群 ID。

说明

您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。

pc-*****************
DescribeType

string

否

是否获取 AI 相关节点信息。

AI

返回参数

名称

类型

描述

示例值

object

DeletionLock

integer

集群删除的锁定状态，取值范围如下：

  • 0：未锁定，可删除集群。

  • 1：锁定，不可删除集群。

0
Category

string

产品系列，取值范围如下：

  • Normal：集群版

  • Basic：单节点

  • Archive：高压缩引擎（X-Engine）

  • NormalMultimaster：多主架构集群版

  • SENormal：标准版

说明

  • PolarDB PostgreSQL 版 PostgreSQL 11 版本不支持单节点。

  • PolarDB MySQL 版 8.0 版本、5.7 版本，PolarDB PostgreSQL 版 PostgreSQL 14 版本支持标准版。

  • PolarDB MySQL 版 8.0 版本，支持高压缩引擎（X-Engine）和多主架构集群版。

Normal
ResourceGroupId

string

资源组 ID。

rg-***************
DataLevel1BackupChainSize

integer

一级备份（快照）总大小，单位为 Byte。

74448896
DBClusterId

string

集群 ID。

pc-*****************
DBType

string

数据库引擎类型。

MySQL
DBClusterNetworkType

string

集群的网络类型。

VPC
IsLatestVersion

boolean

是否为最新内核版本。取值范围如下：

  • true：是

  • false：否

false
HasCompleteStandbyRes

boolean

是否在跨可用区切换后补齐新主库资源。取值范围如下：

  • true：是

  • false：否

false
HotStandbyCluster

string

是否开启存储热备集群(和 Standby 计算节点)。取值范围如下：

  • StandbyClusterON：开启存储热备/开启存储热备和 Standby 计算节点。

  • StandbyClusterOFF：关闭存储热备/关闭存储热备和 Standby 计算节点。

StandbyClusterON
DataSyncMode

string

数据复制关系模式。取值范围如下：

  • AsyncSync：异步

  • SemiSync：半同步

AsyncSync
StandbyHAMode

string

跨可用容灾模式。取值范围如下：

  • ON：开启跨可用容灾模式。

  • OFF：关闭跨可用容灾模式。

  • 0：客户演练模式。

OFF
CompressStorageMode

string

是否为开启存储压缩。取值范围如下：

  • ON：开启

  • OFF：关闭

ON
StorageMax

integer

当前集群规格的最大存储容量，单位为 Byte。

10995116277760
DBVersion

string

数据库引擎版本。

8.0
DBNodes

array<object>

节点信息详情。

object

CreationTime

string

节点创建时间。

2020-03-23T21:35:43Z
FailoverPriority

integer

Failover 优先级。每个节点都有一个 Failover 优先级，决定了当故障切换时，该节点被选举为主节点的概率高低。数值越大，优先级越高。 取值范围为 1~15。

1
MaxIOPS

integer

最大 I/O 请求次数，即 IOPS。

32000
DBNodeClass

string

节点规格。

polar.mysql.x4.large
CpuCores

string

节点 CPU 核数。

2
MemorySize

string

节点内存大小，单位：MB。

8192
DBNodeRole

string

节点角色，取值范围如下：

  • Writer：主节点。

  • Reader：只读节点。

Reader
ZoneId

string

可用区 ID。

cn-hangzhou-i
MaxConnections

integer

最大集群并发连接数。

8000
DBNodeStatus

string

节点状态，取值范围如下：

  • Creating：创建中

  • Running：运行中

  • Deleting：删除中

  • Rebooting：重启中

  • DBNodeCreating：正在增加节点

  • DBNodeDeleting：正在删除节点

  • ClassChanging：正在变更节点规格

  • NetAddressCreating：正在创建网络连接

  • NetAddressDeleting：正在删除网络连接

  • NetAddressModifying：正在修改网络连接

  • MinorVersionUpgrading：小版本升级中

  • Maintaining：实例维护中

  • Switching：切换中

Running
DBNodeId

string

节点 ID。

pi-****************
ImciSwitch

string

是否开启列存索引。取值范围如下：

  • ON：开启

  • OFF：关闭

ON
HotReplicaMode

string

是否开启热备。取值范围如下：

  • ON：开启

  • OFF：关闭

ON
AddedCpuCores

string

秒级弹性扩核的 CPU 核数。

6
MasterId

string

多主架构集群版的主节点 ID。

pi-bp18z52akld3*****
SccMode

string

节点是否开启全局一致性（高性能模式）功能。取值范围如下：

  • ON：开启

  • OFF：关闭

ON
ServerWeight

string

路由权重。 取值范围：1~100。默认值为 1。

1
ServerlessType

string

节点的 Serverless 类型。取值范围如下：

  • AgileServerless：敏态，即固定规格节点。

  • SteadyServerless：稳态，即 Serverless 节点。

说明

仅在 Serverless 集群或开启了 Serverless 功能的固定规格集群，才支持该参数。

SteadyServerless
SubCluster

string

查看节点是在主可用区还是备可用区，主要是资源对等形态在用。 取值范围如下：

  • Primary：主可用区

  • Standby：备可用区

Primary
RemoteMemorySize

string

远端内存大小，单位：MB。

3072
Orca

string

Orca 功能，取值范围如下：

  • on：开启

  • off: 关闭

off
MultiMasterLocalStandby

string

MultiMasterPrimaryNode

string

DBNodeDescription

string

节点描述。

test
SubGroupDescription

string

MirrorInsName

string

开启存储热备和计算热备架构中，节点对应的计算热备节点名。

pi-bp18z52mirror*****
DBNodeCXLRemoteMemory

string

ZoneIds

string

可用区 ID。

cn-hangzhou-i,cn-hangzhou-g
MaintainTime

string

集群的可维护时间段，格式为HH:mmZ-HH:mmZ（UTC 时间）。例如16:00Z-17:00Z表示，0 点到 1 点（UTC+08:00）可以进行例行维护。

18:00Z-19:00Z
Engine

string

集群引擎。

POLARDB
Tags

array<object>

标签信息详情。

object

Key

string

标签键。

test
Value

string

标签值。

MySQL
RequestId

string

请求 ID。

074467EF-86B9-4C23-ACBF-E9B81A******
VPCId

string

专有网络 ID。

vpc-*******************
SearchClusterStatus

string

VSwitchId

string

虚拟交换机 ID。

vsw-*********************
DBClusterDescription

string

集群描述。

test
Expired

string

集群是否到期。

说明

仅付费方式为 Prepaid（包年包月）的集群支持返回该参数。

false
PayType

string

付费类型。取值范围如下：

  • Postpaid：按量付费。

  • Prepaid：预付费（包年包月）。

Prepaid
StoragePayType

string

存储计费类型。取值范围如下：

  • Postpaid：按容量计费（按量付费）。

  • Prepaid：按空间计费（包年包月）。

Prepaid
LockMode

string

锁定模式。取值范围如下：

  • Unlock：未锁定。

  • ManualLock：手动触发锁定。

  • LockByExpiration：集群过期自动锁定。

Unlock
SearchStorageUsed

integer

SearchCompressStorageUsed

integer

StorageSpace

integer

按空间计费（包年包月）的存储空间。单位：Byte。

50
DBVersionStatus

string

当前数据库小版本状态，取值范围如下：

  • Stable：当前版本状态稳定。

  • Old：当前版本过旧，建议升级到最新版本。

  • HighRisk：当前版本有严重缺陷，请立即升级到最新的版本。

  • Beta：当前版本为 Beta 版。

说明

  • 关于如何升级数据库小版本，请参见版本升级。

  • 仅当数据库引擎类型（DBType）为 MySQL 时，返回当前参数。

Stable
CreationTime

string

集群创建时间。

2020-08-14T05:58:42Z
SQLSize

integer

SQL 的存储量，单位为 Byte。若数值为-1，则表示没有数据。

0
InodeTotal

integer

文件系统最大 inode 数。

6,291,456
InodeUsed

integer

当前 inode 使用量。

4,194,304
BlktagTotal

integer

文件系统最大 blktag 数。

7,864,320
BlktagUsed

integer

当前 blktag 使用量。

5,242,880
RegionId

string

地域 ID。

cn-hangzhou
ExpireTime

string

集群到期时间。

说明

仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。

2020-11-14T16:00:00Z
SubCategory

string

计算节点的规格类型，取值范围如下：

  • Exclusive：独享规格

  • General：通用规格

说明

仅 PolarDB MySQL 版且产品系列为集群版时，支持返回该参数。

Exclusive
IsProxyLatestVersion

boolean

是否为数据库代理最新版本，取值范围如下：

  • true：是

  • false：否

false
StorageType

string

存储类型，取值固定为 HighPerformance。

HighPerformance
ServerlessType

string

集群 Serverless 类型。取值范围如下：

  • AgileServerless：敏态，即 Serverless 集群。

  • SteadyServerless：稳态，即开启了 Serverless 功能的固定规格集群。

说明

仅在 Serverless 集群或开启了 Serverless 功能的固定规格集群，才支持该参数。

SteadyServerless
StrictConsistency

string

集群是否开启了多可用区数据强一致。取值范围如下：

  • ON：表示开启了多可用区数据强一致，适用于标准版 3AZ 场景。

  • OFF：表示未开启多可用区数据强一致。

ON
ProxyCpuCores

string

数据库代理 CPU 核数。

4
ProxyStandardCpuCores

string

数据库代理标准配置 CPU 核数。

2
ProxyType

string

数据库代理类型，取值范围如下：

  • Exclusive：企业独享版

  • General ：企业通用版

Exclusive
ProxyStatus

string

数据库代理的状态。取值范围如下：

  • Creating：创建中

  • Running：运行中

  • Deleting：释放中

  • Rebooting：重启中

  • DBNodeCreating：正在增加节点

  • DBNodeDeleting：正在删除节点

  • ClassChanging：正在变更节点规格

  • NetAddressCreating：正在创建网络连接

  • NetAddressDeleting：正在删除网络连接

  • NetAddressModifying：正在修改网络连接

  • Deleted：已释放

Running
ProxyServerlessType

string

数据库代理 Serverless 类型。取值范围如下：

  • AgileServerless：敏态，即 Serverless 集群。

  • SteadyServerless：稳态，即固定规格集群（计费类型为包年包月或按量付费的集群）。

SteadyServerless
Architecture

string

CPU 架构。取值范围如下：

  • X86

  • ARM

X86
AiType

string

AI 节点类型。取值范围如下：

  • SearchNode：搜索节点。

  • DLNode：AI 节点。

DLNode
ProvisionedIops

string

ESSD AutoPL 云盘预配置的读写 IOPS。可能值：0~min{50,000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50000}。

说明 当 StorageType 为 ESSDAUTOPL 时才支持该参数。

2500
AiCreatingTime

string

开启免费 ai 起始时间

2024-03-13T01:20:28Z
SupportInstantSwitchWithImci

string

是否支持兼容列存 IMCI 的无感秒切功能

ON
Orca

string

Orca 功能，取值如下：

  • on：开启

  • off：关闭

ON
SourceDBCluster

string

源集群 ID。

说明 仅 2024 年 6 月 1 日以后从备份集或时间点恢复的集群支持该参数

pc-pz51ziv48317b2880
RestoreType

string

集群恢复方式，其值可能为：

  • RestoreByTime：基于一级备份从时间点恢复。

  • RestoreByBackupSet：基于一级备份从备份集恢复。

  • RestoreByTimeOss：基于二级备份从时间点恢复。

  • RestoreByBackupSetOss：基于二级备份从备份集恢复。

  • CloneFromSourceCluster：从源集群克隆。

说明 仅 2024 年 6 月 1 日以后从备份集或时间点恢复的集群支持该参数

RestoreByTime
RestoreDataPoint

string

  • 若 RestoreType 为 RestoreByTime 或 RestoreByTimeOss，该值表示恢复的时间点。

  • 若 RestoreType 为 RestoreByBackupSet 或 RestoreByBackupSetOss，该值表示恢复所基于的备份集 ID。

说明 仅 2024 年 6 月 1 日以后从备份集或时间点恢复的集群支持该参数

2179639137
SourceRegionId

string

源集群所处地域 ID。

说明 仅源集群 ID 存在的情况下才可能返回。

cn-beijing
ImciAutoIndex

string

自动列存索引提速功能。取值范围如下：

  • ON：开启。

  • OFF：关闭。

OFF
AutoUpgradeMinorVersion

string

小版本升级方式

  • Auto：自动升级

  • Manual：手动升级

Manual
BurstingEnabled

string

ESSD AutoPL 云盘是否开启 IO 性能突发。取值：

  • true：开启

  • false：关闭

false
RowCompression

string

ImperceptibleSwitch

string

无感切换。取值范围如下：

  • true：开启。

  • false：关闭。

StorageUsed

integer

存储空间的使用量，单位为 Byte。

3012558848
CompressStorageUsed

integer

压缩后的存储数据大小。

说明

仅当集群开启存储压缩功能后支持返回该参数。

15529410560
DBClusterStatus

string

集群状态，取值范围请参见集群状态表。

Running

示例

正常返回示例

JSON格式

{
  "DeletionLock": 0,
  "Category": "Normal",
  "ResourceGroupId": "rg-***************",
  "DataLevel1BackupChainSize": 74448896,
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL",
  "DBClusterNetworkType": "VPC",
  "IsLatestVersion": false,
  "HasCompleteStandbyRes": false,
  "HotStandbyCluster": "StandbyClusterON",
  "DataSyncMode": "AsyncSync",
  "StandbyHAMode": "OFF",
  "CompressStorageMode": "ON",
  "StorageMax": 10995116277760,
  "DBVersion": "8.0",
  "DBNodes": [
    {
      "CreationTime": "2020-03-23T21:35:43Z",
      "FailoverPriority": 1,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "CpuCores": "2",
      "MemorySize": "8192",
      "DBNodeRole": "Reader",
      "ZoneId": "cn-hangzhou-i",
      "MaxConnections": 8000,
      "DBNodeStatus": "Running",
      "DBNodeId": "pi-****************",
      "ImciSwitch": "ON",
      "HotReplicaMode": "ON",
      "AddedCpuCores": "6",
      "MasterId": "pi-bp18z52akld3*****",
      "SccMode": "ON",
      "ServerWeight": "1",
      "ServerlessType": "SteadyServerless",
      "SubCluster": "Primary",
      "RemoteMemorySize": "3072",
      "Orca": "off",
      "MultiMasterLocalStandby": "",
      "MultiMasterPrimaryNode": "",
      "DBNodeDescription": "test",
      "SubGroupDescription": "",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": ""
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Key": "test",
      "Value": "MySQL"
    }
  ],
  "RequestId": "074467EF-86B9-4C23-ACBF-E9B81A******",
  "VPCId": "vpc-*******************",
  "SearchClusterStatus": "",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 0,
  "SearchCompressStorageUsed": 0,
  "StorageSpace": 50,
  "DBVersionStatus": "Stable",
  "CreationTime": "2020-08-14T05:58:42Z",
  "SQLSize": 0,
  "InodeTotal": 0,
  "InodeUsed": 0,
  "BlktagTotal": 0,
  "BlktagUsed": 0,
  "RegionId": "cn-hangzhou",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "SubCategory": "Exclusive",
  "IsProxyLatestVersion": false,
  "StorageType": "HighPerformance",
  "ServerlessType": "SteadyServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "SteadyServerless",
  "Architecture": "X86",
  "AiType": "DLNode",
  "ProvisionedIops": "2500",
  "AiCreatingTime": "2024-03-13T01:20:28Z",
  "SupportInstantSwitchWithImci": "ON",
  "Orca": "ON",
  "SourceDBCluster": "pc-pz51ziv48317b2880",
  "RestoreType": "RestoreByTime",
  "RestoreDataPoint": "2179639137",
  "SourceRegionId": "cn-beijing",
  "ImciAutoIndex": "OFF",
  "AutoUpgradeMinorVersion": "Manual",
  "BurstingEnabled": "false",
  "RowCompression": "",
  "ImperceptibleSwitch": "",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running"
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
403 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM.
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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

变更历史

更多信息，参考变更详情。