Tüm Ürünler
Search
Belge Merkezi

:DescribeDBClusterAttribute

Son Güncelleme:Sep 29, 2026

Bir kümenin öznitelik bilgilerini sorgular.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBClusterAttribute

get

*DBCluster

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

None None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

Küme kimliği.

Not

Hesabınızdaki tüm kümelerin ayrıntılarını (küme kimliği dahil) sorgulamak için DescribeDBClusters işlemini çağırabilirsiniz.

pc-*****************

DescribeType

string

No

Yapay zeka ile ilgili düğüm bilgilerinin alınıp alınmayacağını belirtir.

AI

Response elements

Element

Type

Description

Example

object

DeletionLock

integer

Küme silme kilidi durumu. Geçerli değerler:

  • 0: Kilidi açık. Küme silinebilir.

  • 1: Kilitli. Küme silinemez.

0

Category

string

Ürün sürümü. Geçerli değerler:

  • Normal: Küme Sürümü

  • Basic: Tek Düğümlü Sürüm

  • Archive: PolarDB X-Engine Sürümü

  • NormalMultimaster: Çoklu Ana Küme Sürümü

  • SENormal: PolarDB for MySQL Standart Sürümü

Not
  • PolarDB for PostgreSQL 11, Tek Düğümlü Sürümü desteklemez.

  • PolarDB for MySQL 8.0, PolarDB for MySQL 5.7 ve PolarDB for PostgreSQL 14, PolarDB for MySQL Standart Sürümünü destekler.

  • PolarDB for MySQL 8.0, PolarDB X-Engine Sürümünü ve Çoklu Ana Küme Sürümünü destekler.

Normal

ResourceGroupId

string

Kaynak grubu kimliği.

rg-***************

DataLevel1BackupChainSize

integer

  1. seviye yedeklemelerin (anlık görüntüler) toplam boyutu. Birim: bayt.

74448896

DBClusterId

string

Küme kimliği.

pc-*****************

DBType

string

Veritabanı motoru türü.

MySQL

DBClusterNetworkType

string

Kümenin ağ türü.

VPC

IsLatestVersion

boolean

Kümenin en son çekirdek sürümünü çalıştırıp çalıştırmadığını gösterir. Geçerli değerler:

false

HasCompleteStandbyRes

boolean

Bölgeler arası yük devrinden sonra yeni birincil veritabanı için kaynakların yenilenip yenilenmediğini gösterir. Geçerli değerler:

  • true: Kaynaklar yenilenir.

  • false: Kaynaklar yenilenmez.

false

HotStandbyCluster

string

Etkin yedek depolama kümesinin (ve yedek işlem düğümlerinin) etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

  • StandbyClusterON: Etkin yedek depolama kümesi ve yedek işlem düğümleri etkinleştirilir.

  • StandbyClusterOFF: Etkin yedek depolama kümesi ve yedek işlem düğümleri devre dışı bırakılır.

StandbyClusterON

DataSyncMode

string

Veri çoğaltma modu. Geçerli değerler:

  • AsyncSync: eşzamansız

  • SemiSync: yarı eşzamanlı

AsyncSync

StandbyHAMode

string

Bölgeler arası afet kurtarma modu. Geçerli değerler:

  • ON: Bölgeler arası afet kurtarma modu etkinleştirilir.

  • OFF: Bölgeler arası afet kurtarma modu devre dışı bırakılır.

  • 0: Müşteri tatbikat modu.

OFF

CompressStorageMode

string

Depolama sıkıştırmasının etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

ON

StorageMax

integer

Geçerli küme teknik özellikleri için maksimum depolama kapasitesi. Birim: bayt.

10995116277760

DBVersion

string

Veritabanı motoru sürümü.

8.0

DBNodes

array<object>

Düğüm bilgileri.

object

CreationTime

string

Düğümün oluşturulduğu zaman.

2020-03-23T21:35:43Z

FailoverPriority

integer

Yük devri önceliği. Her düğüm, bir yük devri sırasında düğümün birincil düğüm olarak seçilme olasılığını belirleyen bir yük devri önceliğine sahiptir. Daha büyük bir değer daha yüksek bir önceliği gösterir. Geçerli değerler: 1 ile 15 arası.

1

MaxIOPS

integer

Saniyedeki maksimum G/Ç isteği sayısı (IOPS).

32000

DBNodeClass

string

Düğüm teknik özellikleri.

polar.mysql.x4.large

CpuCores

string

Düğümün CPU çekirdeği sayısı.

2

MemorySize

string

Düğümün bellek boyutu. Birim: MB.

8192

DBNodeRole

string

Düğümün rolü. Geçerli değerler:

Reader

ZoneId

string

Bölge kimliği.

cn-hangzhou-i

MaxConnections

integer

Kümeye eşzamanlı bağlantıların maksimum sayısı.

8000

DBNodeStatus

string

Düğümün durumu. Geçerli değerler:

Running

DBNodeId

string

Düğüm kimliği.

pi-****************

ImciSwitch

string

Bellek İçi Sütun Dizininin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

ON

HotReplicaMode

string

Etkin yedeğin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

ON

AddedCpuCores

string

Yerel kaynakların otomatik olarak ölçeklendirilmesiyle eklenen CPU çekirdeği sayısı.

6

MasterId

string

Çoklu Ana Küme Sürümünün birincil düğüm kimliği.

pi-bp18z52akld3*****

SccMode

string

Düğüm için global tutarlılık (yüksek performans modu) özelliğinin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

ON

ServerWeight

string

Yönlendirme ağırlığı.

1

ServerlessType

string

Düğümün sunucusuz türü. Geçerli değerler:

  • AgileServerless: çevik sunucusuz. Düğüm bir sunucusuz düğümdür.

  • SteadyServerless: kararlı sunucusuz. Düğüm, sunucusuz özelliği etkinleştirilmiş, tanımlı teknik özelliklere sahip bir düğümdür.

Not
  • Bu parametre yalnızca sunucusuz kümeler veya sunucusuz özelliği etkinleştirilmiş, tanımlı teknik özelliklere sahip kümeler için desteklenir. Daha fazla bilgi için bkz. Sunucusuz.

SteadyServerless

SubCluster

string

Düğümün birincil bölgede mi yoksa ikincil bölgede mi olduğunu gösterir. Bu parametre esas olarak kaynağa göre simetrik dağıtımlar için kullanılır.

Geçerli değerler:

  • Primary: birincil bölge.

  • Standby: ikincil bölge.

Primary

RemoteMemorySize

string

Uzak bellek boyutu. Birim: MB.

3072

Orca

string

Orca özelliği. Geçerli değerler:

off

MultiMasterLocalStandby

string

Çoklu ana yerel yedek düğüm.

pi-****************

MultiMasterPrimaryNode

string

Çoklu ana birincil düğüm.

pi-****************

DBNodeDescription

string

Düğüm açıklaması.

test

SubGroupDescription

string

Küme alt grubu açıklaması.

test Description

MirrorInsName

string

Etkin yedek depolama ve işlem mimarisinde düğüme karşılık gelen etkin kopyanın adı.

pi-bp18z52mirror*****

DBNodeCXLRemoteMemory

string

CXL uzak bellek yapılandırması.

3072

RemoteMemoryMin

integer

RemoteMemoryMax

integer

RemoteMemoryRecommended

integer

DedicatedHostModel

boolean

ZoneIds

string

Bölge kimliği.

cn-hangzhou-i,cn-hangzhou-g

MaintainTime

string

Kümenin bakım penceresi. Saat HH:mmZ-HH:mmZ biçimindedir (UTC). Örneğin, 16:00Z-17:00Z, rutin bakımın 00:00 ile 01:00 (UTC+08:00) arasında yapılabileceğini gösterir.

18:00Z-19:00Z

Engine

string

Küme motoru.

POLARDB

Tags

array<object>

Etiket bilgileri.

object

Key

string

Etiket anahtarı.

test

Value

string

Etiket değeri.

MySQL

RequestId

string

İstek kimliği.

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

VPCId

string

VPC kimliği.

vpc-*******************

SearchClusterStatus

string

Arama düğümünün çalışma durumu.

Running

VSwitchId

string

vSwitch kimliği.

vsw-*********************

DBClusterDescription

string

Küme açıklaması.

test

Expired

string

Kümenin süresinin dolup dolmadığını gösterir.

false

PayType

string

Faturalandırma yöntemi. Geçerli değerler:

Prepaid

StoragePayType

string

Depolama için faturalandırma yöntemi. Geçerli değerler:

  • Postpaid: kullandıkça öde.

  • Prepaid: abonelik.

Prepaid

LockMode

string

Kilit modu. Geçerli değerler:

Unlock

SearchStorageUsed

integer

Arama düğümünün depolama kullanımı.

3012558848

SearchCompressStorageUsed

integer

Arama düğümünün sıkıştırılmış depolama veri boyutu.

15529410560

StorageSpace

integer

Alana göre faturalandırılan depolama alanı (abonelik). Birim: bayt.

50

DBVersionStatus

string

Geçerli alt sürümün durumu. Geçerli değerler:

  • Stable: Geçerli sürüm kararlıdır.

  • Old: Geçerli sürüm güncel değildir. En son sürüme yükseltin.

  • HighRisk: Geçerli sürümde kritik kusurlar bulunmaktadır. Hemen en son sürüme yükseltin.

  • Beta: Geçerli sürüm bir Beta sürümüdür.

Not
  • Alt sürümü yükseltme hakkında daha fazla bilgi için bkz. Sürüm yükseltme.

  • Bu parametre yalnızca veritabanı motoru türü (DBType) MySQL olduğunda döndürülür.

Stable

CreationTime

string

Kümenin oluşturulduğu zaman.

2020-08-14T05:58:42Z

SQLSize

integer

SQL ifadelerinin depolama boyutu. Birim: bayt. -1 değeri, kullanılabilir veri olmadığını gösterir.

0

InodeTotal

integer

Dosya sistemindeki maksimum inode sayısı.

6,291,456

InodeUsed

integer

Geçerli inode kullanımı.

4,194,304

BlktagTotal

integer

Dosya sistemindeki maksimum blktag sayısı.

7,864,320

BlktagUsed

integer

Geçerli blktag kullanımı.

5,242,880

RegionId

string

Bölge kimliği.

cn-hangzhou

ExpireTime

string

Kümenin sona erme zamanı.

Not

Yalnızca faturalandırma yöntemi Prepaid (abonelik) olan kümeler bu parametre için belirli bir değer döndürür. Postpaid (kullandıkça öde) kümeler boş bir değer döndürür.

2020-11-14T16:00:00Z

SubCategory

string

İşlem düğümünün teknik özellik türü. Geçerli değerler:

  • Exclusive: Ayrılmış

  • General: Genel amaçlı

Not

Bu parametre yalnızca PolarDB for MySQL Küme Sürümü kümeleri için döndürülür.

Exclusive

IsProxyLatestVersion

boolean

Veritabanı proxy'sinin en son sürümde olup olmadığını gösterir. Geçerli değerler:

false

StorageType

string

Depolama türü. Değer HighPerformance olarak sabitlenmiştir.

HighPerformance

ServerlessType

string

Kümenin sunucusuz türü. Geçerli değerler:

  • AgileServerless: çevik sunucusuz. Bu değer bir sunucusuz kümeyi gösterir.

  • SteadyServerless: kararlı sunucusuz. Bu değer, sunucusuz özelliği etkinleştirilmiş, tanımlı teknik özelliklere sahip bir kümeyi gösterir.

Not

Bu parametre yalnızca sunucusuz kümeler veya sunucusuz özelliği etkinleştirilmiş, tanımlı teknik özelliklere sahip kümeler için desteklenir.

SteadyServerless

StrictConsistency

string

Küme için çok bölgeli güçlü veri tutarlılığının etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

ON

ProxyCpuCores

string

Veritabanı proxy'sinin CPU çekirdeği sayısı.

4

ProxyStandardCpuCores

string

Veritabanı proxy'sinin standart yapılandırmasındaki CPU çekirdeği sayısı.

2

ProxyType

string

Veritabanı proxy'sinin türü. Geçerli değerler:

Exclusive

ProxyStatus

string

Veritabanı proxy'sinin durumu. Geçerli değerler:

Running

ProxyServerlessType

string

Veritabanı proxy'sinin sunucusuz türü. Geçerli değerler:

  • AgileServerless: çevik sunucusuz, bu bir sunucusuz kümeyi gösterir.

  • SteadyServerless: kararlı sunucusuz, bu tanımlı teknik özelliklere sahip bir kümeyi (abonelik veya kullandıkça öde kümesi) gösterir.

SteadyServerless

Architecture

string

CPU mimarisi. Geçerli değerler:

X86

AiType

string

AI düğüm türü. Geçerli değerler:

DLNode

ProvisionedIops

string

2500

AiCreatingTime

string

AI özelliğinin oluşturulma zamanı.

2024-03-13T01:20:28Z

SupportInstantSwitchWithImci

string

IMCI ile uyumlu olan sıcak yedekli yük devretme özelliğinin desteklenip desteklenmediğini gösterir.

ON

Orca

string

Orca özelliği. Geçerli değerler:

ON

SourceDBCluster

string

Kaynak kümenin kimliği.

Not Bu parametre yalnızca 1 Haziran 2024 tarihinden sonra bir yedekleme kümesinden veya belirli bir zaman noktasından geri yüklenen kümeler için desteklenir.

pc-pz51ziv48317b2880

RestoreType

string

Küme geri yükleme yöntemi. Geçerli değerler:

  • RestoreByTime: 1. seviye yedeklemeye dayalı olarak belirli bir zaman noktasından geri yükler.

  • RestoreByBackupSet: 1. seviye yedeklemeye dayalı olarak bir yedekleme kümesinden geri yükler.

  • RestoreByTimeOss: 2. seviye yedeklemeye dayalı olarak belirli bir zaman noktasından geri yükler.

  • RestoreByBackupSetOss: 2. seviye yedeklemeye dayalı olarak bir yedekleme kümesinden geri yükler.

  • CloneFromSourceCluster: Kaynak kümeden kopyalar.

Not Bu parametre yalnızca 1 Haziran 2024 tarihinden sonra bir yedekleme kümesinden veya belirli bir zaman noktasından geri yüklenen kümeler için desteklenir.

RestoreByTime

RestoreDataPoint

string

  • RestoreType RestoreByTime veya RestoreByTimeOss ise bu değer, kümenin geri yüklendiği zaman noktasını gösterir.

  • RestoreType RestoreByBackupSet veya RestoreByBackupSetOss ise bu değer, kümenin geri yüklendiği yedekleme kümesinin kimliğini gösterir.

Not Bu parametre yalnızca 1 Haziran 2024 tarihinden sonra bir yedekleme kümesinden veya belirli bir zaman noktasına geri yüklenen kümeler için desteklenir.

2179639137

SourceRegionId

string

Kaynak kümenin bölge kimliği.

cn-beijing

ImciAutoIndex

string

IMCI tabanlı otomatik sorgu hızlandırma özelliği. Geçerli değerler:

OFF

AutoUpgradeMinorVersion

string

Alt sürüm güncelleme politikası.

Manual

BurstingEnabled

string

ESSD AutoPL bulut diski için G/Ç performansında ani artış özelliğinin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

false

RowCompression

string

Satır sıkıştırma ayarı.

OFF

ImperceptibleSwitch

string

Sıcak yedekli yük devretme özelliği. Geçerli değerler:

true

StorageUsed

integer

Depolama kullanımı. Birim: bayt.

3012558848

CompressStorageUsed

integer

Sıkıştırma sonrası depolama verilerinin boyutu.

15529410560

DBClusterStatus

string

Küme durumu. Daha fazla bilgi için Küme durum tablosu bölümüne bakın.

Running

Branch

object

ParentInsName

string

BranchTime

string

BranchLsn

string

ChildBranch

array<object>

object

InsName

string

DBClusterDescription

string

BranchTime

string

BranchLsn

string

HasChild

boolean

ColumnTable

string

Sütun deposu tablosunun etkinleştirilip etkinleştirilmediğini gösterir.

OFF

ConnectionResourceQuota

integer

Bağlantı kaynak kotası (AgenticDB'ye özel).

ConnectionResourceUsed

integer

Kullanılan bağlantı kaynaklarının sayısı (AgenticDB'ye özel).

StorageUpperBound

integer

StorageAutoScale

string

Examples

Success response

JSON format

{
  "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": "pi-****************",
      "MultiMasterPrimaryNode": "pi-****************",
      "DBNodeDescription": "test",
      "SubGroupDescription": "test Description",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": "3072",
      "RemoteMemoryMin": 0,
      "RemoteMemoryMax": 0,
      "RemoteMemoryRecommended": 0,
      "DedicatedHostModel": false
    }
  ],
  "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": "Running",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 3012558848,
  "SearchCompressStorageUsed": 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": "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": "OFF\n",
  "ImperceptibleSwitch": "true",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running",
  "Branch": {
    "ParentInsName": "",
    "BranchTime": "",
    "BranchLsn": "",
    "ChildBranch": [
      {
        "InsName": "",
        "DBClusterDescription": "",
        "BranchTime": "",
        "BranchLsn": "",
        "HasChild": false
      }
    ]
  },
  "ColumnTable": "OFF",
  "ConnectionResourceQuota": 0,
  "ConnectionResourceUsed": 0,
  "StorageUpperBound": 0,
  "StorageAutoScale": ""
}

Error codes

HTTP status code

Error code

Error message

Description

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.