DescribeDBClusterAttribute_云数据库 PolarDB_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClusterAttribute
Get
DBCluster
acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

请求参数

字段名称字段详情
DBClusterIdstring

集群 ID。展开详情

示例值:pc-*****************参考取值来源:
    ModifyDBCluster
    CreateDBCluster
    DescribeDBClusters
    RestartDBLink
    EnableDBClusterServerless
    TransformDBClusterPayType
    DisableDBClusterServerless
DescribeTypestring

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

示例值:AI

返回参数

字段名称字段详情
DeletionLockinteger<int32>

集群删除的锁定状态,取值范围如下:展开详情

示例值:0
Categorystring

产品系列,取值范围如下:展开详情

示例值:Normal
ResourceGroupIdstring

资源组 ID。

示例值:rg-***************
DataLevel1BackupChainSizeinteger<int64>

一级备份(快照)总大小,单位为 Byte。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:74448896
DBClusterIdstring

集群 ID。

示例值:pc-*****************
DBTypestring

数据库引擎类型。

示例值:MySQL
DBClusterNetworkTypestring

集群的网络类型。

示例值:VPC
IsLatestVersionboolean

是否为最新内核版本。取值范围如下:展开详情

示例值:false
HasCompleteStandbyResboolean

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

示例值:false
HotStandbyClusterstring

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

示例值:StandbyClusterON
DataSyncModestring

数据复制关系模式。取值范围如下:展开详情

示例值:AsyncSync
StandbyHAModestring

跨可用容灾模式。取值范围如下:展开详情

示例值:OFF
CompressStorageModestring

是否为开启存储压缩。取值范围如下:展开详情

示例值:ON
StorageMaxinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10995116277760
DBVersionstring

数据库引擎版本。

示例值:8.0
DBNodesarray<object>

节点信息详情。

ZoneIdsstring

可用区 ID。

示例值:cn-hangzhou-i,cn-hangzhou-g
MaintainTimestring

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

示例值:18:00Z-19:00Z
Enginestring

集群引擎。

示例值:POLARDB
Tagsarray<object>

标签信息详情。

RequestIdstring

请求 ID。

示例值:074467EF-86B9-4C23-ACBF-E9B81A******
VPCIdstring

专有网络 ID。

示例值:vpc-*******************
DBClusterStatusstring

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

示例值:Running
VSwitchIdstring

虚拟交换机 ID。

示例值:vsw-*********************
DBClusterDescriptionstring

集群描述。

示例值:test
Expiredstring

集群是否到期。展开详情

示例值:false
PayTypestring

付费类型。取值范围如下:展开详情

示例值:Prepaid
StoragePayTypestring

存储计费类型。取值范围如下:展开详情

示例值:Prepaid
LockModestring

锁定模式。取值范围如下: 展开详情

示例值:Unlock
StorageUsedinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:3012558848
CompressStorageUsedinteger<int64>

压缩后的存储数据大小。展开详情

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:15529410560
StorageSpaceinteger<int64>

按空间计费(包年包月)的存储空间。单位:Byte。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:50
DBVersionStatusstring

当前数据库小版本状态,取值范围如下:展开详情

示例值:Stable
CreationTimestring

集群创建时间。

示例值:2020-08-14T05:58:42Z
SQLSizeinteger<int64>

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

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:0
InodeTotalinteger<int64>

文件系统最大 inode 数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:6,291,456
InodeUsedinteger<int64>

当前 inode 使用量。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:4,194,304
BlktagTotalinteger<int64>

文件系统最大 blktag 数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:7,864,320
BlktagUsedinteger<int64>

当前 blktag 使用量。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:5,242,880
RegionIdstring

地域 ID。

示例值:cn-hangzhou
ExpireTimestring

集群到期时间。展开详情

示例值:2020-11-14T16:00:00Z
SubCategorystring

计算节点的规格类型,取值范围如下:展开详情

示例值:Exclusive
IsProxyLatestVersionboolean

是否为数据库代理最新版本,取值范围如下:展开详情

示例值:false
StorageTypestring

存储类型,取值固定为 HighPerformance

示例值:HighPerformance
ServerlessTypestring

Serverless 类型。取值范围如下:展开详情

示例值:AgileServerless
StrictConsistencystring

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

示例值:ON
ProxyCpuCoresstring

数据库代理 CPU 核数。

示例值:4
ProxyStandardCpuCoresstring

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

示例值:2
ProxyTypestring

数据库代理类型,取值范围如下:展开详情

示例值:Exclusive
ProxyStatusstring

数据库代理的状态。取值范围如下:展开详情

示例值:Running
ProxyServerlessTypestring

数据库代理 Serverless 类型。当前取值固定为 AgileServerless。

示例值:AgileServerless
Architecturestring

CPU 架构。取值范围如下:展开详情

示例值:X86
AiTypestring

AI 节点类型。取值范围如下:展开详情

示例值:DLNode
ProvisionedIopsstring

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

展开详情
示例值:2500
AiCreatingTimestring

开启免费 ai 起始时间

示例值:2024-03-13T01:20:28Z
SupportInstantSwitchWithImcistring

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

示例值:ON
Orcastring

Orca 功能,取值如下:展开详情

示例值:ON
SourceDBClusterstring

源集群 ID。展开详情

示例值:pc-pz51ziv48317b2880
RestoreTypestring

集群恢复方式,其值可能为:展开详情

示例值:RestoreByTime
RestoreDataPointstring
  • 若 RestoreType 为 RestoreByTimeRestoreByTimeOss,该值表示恢复的时间点。展开详情
示例值:2179639137
SourceRegionIdstring

源集群所处地域 ID。展开详情

示例值:cn-beijing
ImciAutoIndexstring

自动列存索引提速功能。取值范围如下:展开详情

示例值:OFF
AutoUpgradeMinorVersionstring

小版本升级方式展开详情

示例值:Manual
BurstingEnabledstring

ESSD AutoPL 云盘是否开启 IO 性能突发。取值:展开详情

示例值:false
RowCompressionstring
ImperceptibleSwitchstring

无感切换。取值范围如下:展开详情

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断

变更历史

变更时间变更内容概要操作
2025-03-25
变更返回参数
2025-03-20
变更返回参数
2025-01-09
变更返回参数
2024-11-14
变更返回参数

相关示例

查看POLARDB集群的详细属性
2021-02-16