首页 云原生数据库 PolarDB API参考 MySQL版/PostgreSQL版 API参考指南 API目录 集群管理 DescribeDBClusterAttribute - 查看PolarDB集群的详细属性

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

更新时间: 2023-09-13 15:51:39

查看PolarDB集群的详细属性。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClusterAttribute
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群ID。

说明 您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息,包括集群ID。
pc-*****************
DescribeTypestring

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

AI

返回参数

名称类型描述示例值
object
DeletionLockinteger

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

  • 0:未锁定,可删除集群。
  • 1:锁定,不可删除集群。
0
Categorystring

产品系列,取值范围如下:

  • Normal:集群版
  • Basic:单节点
  • Archive:高压缩引擎(X-Engine)
  • NormalMultimaster:多主架构集群版
  • SENormal:标准版
说明
  • 仅PolarDB MySQL版支持单节点产品系列。
  • 仅PolarDB MySQL版8.0.1版本的集群,支持标准版产品系列。
  • 仅PolarDB MySQL版8.0版本的集群,支持高压缩引擎(X-Engine)和多主架构集群版产品系列。
  • Normal
    ResourceGroupIdstring

    资源组ID。

    rg-***************
    DataLevel1BackupChainSizelong

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

    74448896
    DBClusterIdstring

    集群ID。

    pc-*****************
    DBTypestring

    数据库引擎类型。

    MySQL
    DBClusterNetworkTypestring

    集群的网络类型。

    VPC
    IsLatestVersionboolean

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

    • true:是

    • false:否

    false
    HasCompleteStandbyResboolean

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

    • true:是
    • false:否
    false
    HotStandbyClusterstring

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

    • StandbyClusterON:开启存储热备/开启存储热备和Standby计算节点。
    • StandbyClusterOFF:关闭存储热备/关闭存储热备和Standby计算节点。
    StandbyClusterON
    DataSyncModestring

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

    • AsyncSync:异步
    • SemiSync:半同步
    AsyncSync
    StandbyHAModestring

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

    • ON:开启跨可用容灾模式。
    • OFF:关闭跨可用容灾模式。
    • 0:客户演练模式。
    OFF
    CompressStorageModestring

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

    • ON:开启
    • OFF:关闭
    ON
    StorageMaxlong

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

    10995116277760
    DBVersionstring

    数据库引擎版本。

    8.0
    DBNodesobject []

    节点信息详情。

    CreationTimestring

    节点创建时间。

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

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

    1
    MaxIOPSinteger

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

    32000
    DBNodeClassstring

    节点规格。

    polar.mysql.x4.large
    DBNodeRolestring

    节点角色,取值范围如下:

    • Writer:主节点。
    • Reader:只读节点。
    Reader
    ZoneIdstring

    可用区ID。

    cn-hangzhou-i
    MaxConnectionsinteger

    最大集群并发连接数。

    8000
    DBNodeStatusstring

    节点状态,取值范围如下:

    • Creating:创建中
    • Running:运行中
    • Deleting:删除中
    • Rebooting:重启中
    • DBNodeCreating:正在增加节点
    • DBNodeDeleting:正在删除节点
    • ClassChanging:正在变更节点规格
    • NetAddressCreating:正在创建网络连接
    • NetAddressDeleting:正在删除网络连接
    • NetAddressModifying:正在修改网络连接
    • MinorVersionUpgrading:小版本升级中
    • Maintaining:实例维护中
    • Switching:切换中
    Running
    DBNodeIdstring

    节点ID。

    pi-****************
    ImciSwitchstring

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

    • ON:开启

    • OFF:关闭

    ON
    HotReplicaModestring

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

    • ON:开启

    • OFF:关闭

    ON
    AddedCpuCoresstring

    秒级弹性扩核的CPU核数。

    6
    MasterIdstring

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

    pi-bp18z52akld3*****
    SccModestring

    节点是否开启全局一致性(高性能模式)功能。取值范围如下:

    • ON:开启

    • OFF:关闭

    ON
    ServerWeightstring

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

    1
    ServerlessTypestring

    Serverless类型。当前取值固定为AgileServerless(敏态)。

    说明 仅Serverless集群支持该参数。
    AgileServerless
    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
    Tagsobject []

    标签信息详情。

    Keystring

    标签键。

    test
    Valuestring

    标签值。

    MySQL
    RequestIdstring

    请求ID。

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

    专有网络ID。

    vpc-*******************
    DBClusterStatusstring

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

    Running
    VSwitchIdstring

    虚拟交换机ID。

    vsw-*********************
    DBClusterDescriptionstring

    集群描述。

    test
    Expiredstring

    集群是否到期。

    说明 仅付费方式为Prepaid(包年包月)的集群支持返回该参数。
    false
    PayTypestring

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

    • Postpaid:按量付费。
    • Prepaid:预付费(包年包月)。
    Prepaid
    StoragePayTypestring

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

    • Postpaid:按容量计费(按量付费)。
    • Prepaid:按空间计费(包年包月)。
    Prepaid
    LockModestring

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

    • Unlock:未锁定。
    • ManualLock:手动触发锁定。
    • LockByExpiration:集群过期自动锁定。
    Unlock
    StorageUsedlong

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

    3012558848
    StorageSpacelong

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

    50
    DBVersionStatusstring

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

    • Stable:当前版本状态稳定。
    • Old:当前版本过旧,建议升级到最新版本。
    • HighRisk:当前版本有严重缺陷,请立即升级到最新的版本。
    说明 关于如何升级数据库小版本,请参见版本升级
    Stable
    CreationTimestring

    集群创建时间。

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

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

    0
    InodeTotallong

    文件系统最大inode数。

    6,291,456
    InodeUsedlong

    当前inode使用量。

    4,194,304
    BlktagTotallong

    文件系统最大blktag数。

    7,864,320
    BlktagUsedlong

    当前blktag使用量。

    5,242,880
    RegionIdstring

    地域ID。

    cn-hangzhou
    ExpireTimestring

    集群到期时间。

    说明 仅付费方式为Prepaid(包年包月)的集群会返回具体参数值,Postpaid(按量付费)集群则返回空值。
    2020-11-14T16:00:00Z
    SubCategorystring

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

    • Exclusive:独享规格
    • General:通用规格
    说明 仅PolarDB MySQL版且产品系列为集群版时,支持返回该参数。
    Exclusive
    DeployUnitstring

    此返回参数已经废弃,不建议采用。

    default
    IsProxyLatestVersionboolean

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

    • true:是
    • false:否
    false
    StorageTypestring

    存储类型,取值固定为HighPerformance

    HighPerformance
    ServerlessTypestring

    Serverless类型。当前取值固定为AgileServerless(敏态)。

    AgileServerless
    StrictConsistencystring

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

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

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

    ON
    ProxyCpuCoresstring

    数据库代理CPU核数。

    4
    ProxyStandardCpuCoresstring

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

    2
    ProxyTypestring

    数据库代理类型,取值范围如下:

    • Exclusive:企业独享版
    • General :企业通用版
    Exclusive
    ProxyStatusstring

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

    • Creating:创建中
    • Running:运行中
    • Deleting:释放中
    • Rebooting:重启中
    • DBNodeCreating:正在增加节点
    • DBNodeDeleting:正在删除节点
    • ClassChanging:正在变更节点规格
    • NetAddressCreating:正在创建网络连接
    • NetAddressDeleting:正在删除网络连接
    • NetAddressModifying:正在修改网络连接
    • Deleted:已释放
    Running
    ProxyServerlessTypestring

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

    AgileServerless
    Architecturestring

    CPU 架构。取值范围如下:

    • X86
    • ARM
    X86
    AiTypestring

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

    • SearchNode:搜索节点。
    • DLNode:AI节点。
    DLNode

    示例

    正常返回示例

    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",
          "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": "AgileServerless"
        }
      ],
      "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-*******************",
      "DBClusterStatus": "Running",
      "VSwitchId": "vsw-*********************",
      "DBClusterDescription": "test",
      "Expired": "false",
      "PayType": "Prepaid",
      "StoragePayType": "Prepaid",
      "LockMode": "Unlock",
      "StorageUsed": 3012558848,
      "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",
      "DeployUnit": "default",
      "IsProxyLatestVersion": false,
      "StorageType": "HighPerformance",
      "ServerlessType": "AgileServerless",
      "StrictConsistency": "ON",
      "ProxyCpuCores": "4",
      "ProxyStandardCpuCores": "2",
      "ProxyType": "Exclusive",
      "ProxyStatus": "Running",
      "ProxyServerlessType": "AgileServerless",
      "Architecture": "X86",
      "AiType": "DLNode"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
    403Forbidden.RAMUser not authorized to operate on the specified resource, or this API does not support RAM.用户无权操作指定资源,或此API不支持RAM。
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2023-08-31OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2023-07-06OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:DescribeType
    出参OpenAPI 返回结构发生变更
    2023-06-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
      新增错误码:403
    2023-04-11OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2023-03-28OpenAPI 描述信息更新,OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    API 描述OpenAPI 描述信息更新
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2022-11-02OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2022-06-02OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2021-12-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2021-12-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2021-12-07OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    2021-12-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    2021-12-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    出参OpenAPI 返回结构发生变更
    阿里云首页 云原生数据库 PolarDB 相关技术圈