查看集群属性信息。
调试
您可以在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 |
返回参数
示例
正常返回示例
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": "AgileServerless",
"SubCluster": "Primary",
"RemoteMemorySize": "3072",
"Orca": "off",
"MirrorInsName": "pi-bp18z52mirror*****",
"MultiMasterLocalStandby": "",
"MultiMasterPrimaryNode": "",
"DBNodeDescription": ""
}
],
"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,
"CompressStorageUsed": 15529410560,
"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": "AgileServerless",
"StrictConsistency": "ON",
"ProxyCpuCores": "4",
"ProxyStandardCpuCores": "2",
"ProxyType": "Exclusive",
"ProxyStatus": "Running",
"ProxyServerlessType": "AgileServerless",
"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",
"BurstingEnabled": ""
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
| 403 | Forbidden.RAM | User not authorized to operate on the specified resource, or this API does not support RAM. | 用户无权操作指定资源，或此API不支持RAM。 |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-20 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-07-30 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-06-06 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-18 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-22 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-12-07 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-11-06 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-31 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-06-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-04-11 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-28 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-11-02 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-06-02 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-12-07 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-12-07 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |