PolarDB kümelerinin bir listesini veya RAM yetkilendirmesine sahip kümelerin ayrıntılarını sorgular.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
polardb:DescribeDBClusters |
list |
*DBCluster
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
Bölge kimliği. Not
Kullanılabilir bölgeleri sorgulamak için DescribeRegions işlemini çağırabilirsiniz. |
cn-hangzhou |
| DBClusterIds |
string |
No |
Küme kimlikleri. Birden fazla küme kimliğini virgül (,) ile ayırın. |
pc-**************** |
| DBClusterDescription |
string |
No |
Küme açıklaması. Bulanık eşleştirme desteklenir. |
pc-**************** |
| ConnectionString |
string |
No |
Veritabanı uç noktası. |
********.rwlb.polardb-pg-public.rds.aliyuncs.com |
| DBClusterStatus |
string |
No |
Küme durumu. Geçerli değerler için Küme durumu tablosu sayfasına bakın. |
Running |
| DBType |
string |
No |
Veritabanı türü. Geçerli değerler:
|
MySQL |
| DescribeType |
string |
No |
Liste için sorgu modu. Simple değeri, yalnızca kümelerin temel meta verilerinin döndürüldüğü basitleştirilmiş modu belirtir. Not
Bu parametre belirtilmezse, varsayılan olarak ayrıntılı mod kullanılır ve kümelerin ayrıntılı bilgileri döndürülür. |
Simple |
| DBVersion |
string |
No |
Veritabanı sürümü. |
5.6 |
| RecentCreationInterval |
integer |
No |
Son N gün içinde oluşturulan kümeleri filtreler. Geçerli değerler: 0 ile 15 arası. |
7 |
| RecentExpirationInterval |
integer |
No |
N gün içinde süresi dolacak kümeleri filtreler. Geçerli değerler: 0 ile 15 arası. |
6 |
| Expired |
boolean |
No |
Kümenin süresinin dolup dolmadığını belirtir. Geçerli değerler:
|
true |
| PageSize |
integer |
No |
Sayfa başına giriş sayısı. Geçerli değerler: 30, 50 ve 100. Varsayılan değer: 30. |
30 |
| PageNumber |
integer |
No |
Sayfa numarası. Değer, Integer veri türünün maksimum değerini aşmayan pozitif bir tam sayı olmalıdır. Varsayılan değer: 1. |
10 |
| ResourceGroupId |
string |
No |
Kaynak grubu kimliği. |
rg-********** |
| Tag |
array<object> |
No |
Etiket listesi. |
|
|
object |
No |
|||
| Key |
string |
No |
Etiket anahtarı. Küme listesini etiketlere göre filtreleyebilirsiniz. En fazla 20 etiket anahtar-değer çifti belirtebilirsiniz. Her etiket anahtar-değer çiftindeki n sayısı benzersiz olmalı ve 1'den başlayan ardışık bir tam sayı olmalıdır. Tag.n.Key değeri Tag.n.Value değeridir. Not
Etiket anahtarı en fazla 64 karakter uzunluğunda olabilir ve |
MySQL |
| Value |
string |
No |
Etiket anahtarına karşılık gelen etiket değeri. Not
Etiket değeri en fazla 64 karakter uzunluğunda olabilir ve |
5.6 |
| PayType |
string |
No |
Faturalandırma yöntemi. Geçerli değerler:
|
Postpaid |
| DBNodeIds |
string |
No |
Düğüm kimlikleri. Birden fazla düğüm kimliği belirtebilir ve bunları virgül (,) ile ayırabilirsiniz. |
pi-*************** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| TotalRecordCount |
integer |
Toplam giriş sayısı. |
16 |
| PageRecordCount |
integer |
Geçerli sayfada döndürülen küme sayısı. |
5 |
| RequestId |
string |
İstek kimliği. |
9B7BFB11-C077-4FE3-B051-F69CEB****** |
| PageNumber |
integer |
Sayfa numarası. |
12 |
| Items |
object |
||
| DBCluster |
array<object> |
Küme listesi. |
|
|
array<object> |
|||
| VpcId |
string |
VPC kimliği. |
vpc-**************** |
| VswitchId |
string |
vSwitch kimliği. |
vsw-*************** |
| ExpireTime |
string |
Kümenin sona erme zamanı. Not
Yalnızca faturalandırma yöntemi Prepaid (abonelik) olan kümeler için belirli bir değer döndürülür. Postpaid (kullandıkça öde) kümeler için boş bir değer döndürülür. Sona erme zamanı, UTC cinsinden ISO 8601 standardı olan yyyy-MM-ddTHH:mm:ssZ formatındadır. |
2020-11-14T16:00:00Z |
| Expired |
string |
Kümenin süresinin dolup dolmadığını gösterir. Geçerli değerler:
Not
Bu parametre yalnızca faturalandırma yöntemi Prepaid (abonelik) olan kümeler için döndürülür. |
false |
| DBNodeNumber |
integer |
Düğüm sayısı. |
2 |
| CreateTime |
string |
Kümenin oluşturulma zamanı. Zaman, UTC cinsinden ISO 8601 standardı olan yyyy-MM-ddTHH:mm:ssZ formatındadır. |
2020-08-14T05:58:42Z |
| PayType |
string |
Faturalandırma yöntemi. Geçerli değerler:
|
Prepaid |
| StoragePayType |
string |
Depolama faturalandırma yöntemi. Geçerli değerler:
|
Prepaid |
| ServerlessType |
string |
Serverless türü. AgileServerless değeri, kümenin bir Serverless kümesi olduğunu gösterir. Boş bir değer, kümenin sıradan kümelerden biri olduğunu gösterir. |
AgileServerless |
| StrictConsistency |
string |
Küme için bölgeler arası güçlü veri tutarlılığının etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:
|
ON |
| DBNodeClass |
string |
Düğüm teknik özellikleri. |
polar.mysql.x4.large |
| Tags |
object |
||
| Tag |
array<object> |
Etiket listesi. |
|
|
object |
|||
| Key |
string |
Etiket anahtarı. |
MySQL |
| Value |
string |
Etiket değeri. |
5.6 |
| DBType |
string |
Veritabanı türü. |
MySQL |
| LockMode |
string |
Kümenin kilit durumu. Geçerli değerler:
|
Unlock |
| DBNodes |
object |
||
| DBNode |
array<object> |
Düğüm listesi. |
|
|
object |
|||
| DBNodeClass |
string |
Düğüm teknik özellikleri. |
polar.mysql.x4.large |
| ZoneId |
string |
Bölge kimliği. |
cn-hangzhou-i |
| DBNodeRole |
string |
Düğüm rolü. Geçerli değerler:
|
Reader |
| DBNodeId |
string |
Düğüm kimliği. |
pi-**************** |
| RegionId |
string |
Bölge kimliği. |
cn-hangzhou |
| Serverless |
string |
Geçerli düğüm için Serverless özelliğinin etkinleştirilip etkinleştirilmediğini gösterir.
|
ON |
| ImciSwitch |
string |
Bellek İçi Sütun Dizini (IMCI) özelliğinin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:
Valid values:
|
OFF |
| HotReplicaMode |
string |
Sıcak yedek özelliğinin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:
|
OFF |
| RegionId |
string |
Bölge kimliği. |
cn-hangzhou |
| DeletionLock |
integer |
Kümenin silme koruması durumu. Geçerli değerler:
Not
Kilitli durumdaki bir kümeyi silemezsiniz. |
0 |
| DBVersion |
string |
Veritabanı sürümü. |
5.6 |
| DBClusterId |
string |
Küme kimliği. |
pc-**************** |
| DBClusterStatus |
string |
Küme durumu. |
Running |
| ResourceGroupId |
string |
Kaynak grubu kimliği. |
rg-************ |
| SearchStorageUsed |
integer |
Search düğümünün depolama kullanımı. |
89227945573 |
| StorageSpace |
integer |
Alana dayalı abonelik faturalandırma yöntemi için depolama kapasitesi. Birim: bayt. |
50 |
| DBClusterNetworkType |
string |
Kümenin ağ türü. |
VPC |
| DBClusterDescription |
string |
Küme açıklaması. |
GDN-1 |
| ZoneId |
string |
Bölge kimliği. |
cn-hangzhou-i |
| Engine |
string |
Küme motoru. |
POLARDB |
| Category |
string |
Küme sürümü. Geçerli değerler:
|
Normal |
| AiType |
string |
AI düğümünün durumu. Geçerli değerler:
Valid values:
|
SearchNode |
| CpuCores |
string |
CPU çekirdeği sayısı. |
1 |
| MemorySize |
string |
Düğümün bellek boyutu. Birim: MB. |
2048 |
| StorageType |
string |
Depolama türü. Enterprise Edition için geçerli değerler:
Standard Edition için geçerli değerler:
|
essdautopl |
| HotStandbyCluster |
string |
Sıcak yedek depolama kümesi. Geçerli değerler:
|
OFF |
| SubCategory |
string |
İşlem düğümünün teknik özellik türü. Geçerli değerler:
|
Exclusive |
| StorageUsed |
integer |
Kümenin kullanılan depolama kapasitesi. Birim: bayt. |
3009413120 |
| RemoteMemorySize |
string |
Uzak belleğin boyutu. Birim: MB. |
3612 |
| ConnectionResourceQuota |
integer |
Bağlantı kaynakları kotası (AgenticDB'ye özel). |
0 |
| ConnectionResourceUsed |
integer |
AgenticDB tarafından kullanılan bağlantı kaynakları. |
0 |
Examples
Success response
JSON format
{
"TotalRecordCount": 16,
"PageRecordCount": 5,
"RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
"PageNumber": 12,
"Items": {
"DBCluster": [
{
"VpcId": "vpc-****************",
"VswitchId": "vsw-***************",
"ExpireTime": "2020-11-14T16:00:00Z",
"Expired": "false",
"DBNodeNumber": 2,
"CreateTime": "2020-08-14T05:58:42Z",
"PayType": "Prepaid",
"StoragePayType": "Prepaid",
"ServerlessType": "AgileServerless",
"StrictConsistency": "ON",
"DBNodeClass": "polar.mysql.x4.large",
"Tags": {
"Tag": [
{
"Key": "MySQL",
"Value": "5.6"
}
]
},
"DBType": "MySQL",
"LockMode": "Unlock",
"DBNodes": {
"DBNode": [
{
"DBNodeClass": "polar.mysql.x4.large",
"ZoneId": "cn-hangzhou-i",
"DBNodeRole": "Reader",
"DBNodeId": "pi-****************",
"RegionId": "cn-hangzhou",
"Serverless": "ON",
"ImciSwitch": "OFF",
"HotReplicaMode": "OFF"
}
]
},
"RegionId": "cn-hangzhou",
"DeletionLock": 0,
"DBVersion": "5.6",
"DBClusterId": "pc-****************",
"DBClusterStatus": "Running",
"ResourceGroupId": "rg-************",
"SearchStorageUsed": 89227945573,
"StorageSpace": 50,
"DBClusterNetworkType": "VPC",
"DBClusterDescription": "GDN-1",
"ZoneId": "cn-hangzhou-i",
"Engine": "POLARDB",
"Category": "Normal",
"AiType": "SearchNode",
"CpuCores": "1",
"MemorySize": "2048",
"StorageType": "essdautopl",
"HotStandbyCluster": "OFF",
"SubCategory": "Exclusive",
"StorageUsed": 3009413120,
"RemoteMemorySize": "3612",
"ConnectionResourceQuota": 0,
"ConnectionResourceUsed": 0
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidRegionId.Malformed | The specified parameter RegionId is not valid. | Belirtilen RegionId parametresi geçersiz. |
| 400 | NumberExceed.Tags | The Tags parameter's number is exceed. | Etiket parametrelerinin sayısı geçerli değeri aştığı için işlem başarısız oldu. Geçerli değer: 20. |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | Belirtilen PageSize parametresi geçersiz. |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | Belirtilen PageNumber parametresi geçersiz. |
| 400 | InvalidRecentCreationInterval.Malformed | The specified parameter RecentCreationInterval is not valid. | Belirtilen RecentCreationInterval parametresi geçersiz. |
| 400 | InvalidRecentExpirationInterval.Malformed | The specified parameter RecentExpirationInterval is not valid. | Belirtilen RecentExpirationInterval parametresi geçersiz. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | Bilinmeyen bir hata, istisna veya arıza nedeniyle isteğin işlenmesi başarısız oldu. |
| 404 | DBTypeOrDBVersion.Malformed | The specified DBType does not match DBVersion. | Belirtilen DBType, DBVersion ile eşleşmiyor. |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | İstek, geçici bir sunucu arızası nedeniyle başarısız oldu. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.