Belirtilen koşulları karşılayan bir veya daha fazla ApsaraDB RDS örneğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz.
Yanıtı kontrol etmek için aşağıdaki yöntemlerden birini kullanabilirsiniz:
-
-
Yöntem: Sayfa başına düşen giriş sayısını belirtmek için
MaxResultsparametresini kullanın. Ardından, sonraki sayfayı görüntülemek için kullanılan belirteci belirtmek üzereNextTokenparametresini kullanın.NextTokenparametresi,DescribeDBInstancesişlemine yapılan en son çağrıdaNextTokenparametresi için döndürülen değere ayarlanır.NotDescribeDBInstances işlemini sayfalandırılmış bir sorgu gerçekleştirmek üzere ilk kez çağırdığınızda yalnızca
MaxResultsparametresini belirtmeniz gerekir. Bu durumda işlem, ilk sayfanın verilerini veNextTokenparametresinin değerini döndürür.
-
Yöntem: Sayfa başına düşen giriş sayısını belirtmek için PageSize parametresini kullanın. Ardından sonraki sayfayı görüntülemek için PageNumber parametresini kullanın.
Önceki yöntemlerden yalnızca birini kullanabilirsiniz. Çok sayıda giriş döndürülüyorsa sorgu hızını artırmak için 1. Yöntemi kullanmanızı öneririz.
Hata Ayıklama
İstek parametreleri
| Parametre | Tür | Gerekli | Örnek | Açıklama |
| Action | String | Evet | DescribeDBInstances | Gerçekleştirmek istediğiniz işlem. Değeri DescribeDBInstances olarak ayarlayın. |
| ClientToken | String | Hayır | ETnLKlblzczshOTUbOCzxxxxxxx | İsteğin yinelenmezliğini (idempotence) sağlamak için kullanılan istemci belirteci. Değeri istemci aracılığıyla oluşturabilirsiniz ancak farklı istekler arasında benzersiz olduğundan emin olmanız gerekir. Belirteç yalnızca ASCII karakterleri içerebilir ve uzunluğu 64 karakteri aşamaz. |
| proxyId | String | Hayır | API | Örneklerde kullanılan proxy modunun kimliği. |
| Engine | String | Hayır | MySQL | Örnekler tarafından çalıştırılan veritabanı altyapısı. Geçerli değerler:
Bu işlem varsayılan olarak desteklenen veritabanı altyapılarından herhangi birini çalıştıran örnekleri döndürür. |
| ZoneId | String | Hayır | cn-hangzhou-a | Örneklerin ait olduğu alanın kimliği. |
| ResourceGroupId | String | Hayır | rg-acfmyxxxxx | Örneklerin ait olduğu kaynak grubunun kimliği. |
| DBInstanceStatus | String | Hayır | Running | Örneklerin durumu. Daha fazla bilgi için bkz. Örnek durum tablosu. |
| Expired | String | Hayır | True | Örneklerin süresinin dolup dolmadığını belirtir. Geçerli değerler:
|
| SearchKey | String | Hayır | rm-uf6w | Örneklerin kimliklerinde veya açıklamalarında bulunan anahtar kelimeler. |
| DBInstanceId | String | Hayır | rm-uf6wjk5xxxxxxx | Örneğin kimliği. Örneklerin kimliklerini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz. |
| DBInstanceType | String | Hayır | Primary | Örneklerin rolü. Geçerli değerler:
Bu işlem varsayılan olarak desteklenen rollerden herhangi birini üstlenen örnekleri döndürür. |
| RegionId | String | Evet | cn-hangzhou | Örneklerin bulunduğu bölgenin kimliği. En güncel bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz. |
| PageSize | Integer | Hayır | 30 | Her sayfada döndürülecek giriş sayısı. Geçerli değerler: 1 ile 100 arasındadır. Varsayılan değer: 30. |
| PageNumber | Integer | Hayır | 1 | Döndürülecek sayfanın numarası. Geçerli değerler: sıfır olmayan herhangi bir pozitif tam sayı. Varsayılan değer: 1. |
| InstanceNetworkType | String | Hayır | Classic | Örneklerin ağ türü. Geçerli değerler:
Bu işlem varsayılan olarak desteklenen ağ türlerinden herhangi birinde bulunan örnekleri döndürür. |
| VpcId | String | Hayır | vpc-uf6f7l4fg90xxxxxxxxxx | Örneklerin ait olduğu sanal özel cloud (VPC) kimliği. |
| VSwitchId | String | Hayır | vsw-uf6adz52c2pxxxxxxxxxx | vSwitch kimliği. |
| DBInstanceClass | String | Hayır | rds.mys2.small | Örneklerin örnek türü. Bilgi için bkz. Birincil ApsaraDB RDS örnek türleri. |
| EngineVersion | String | Hayır | 5,7 | Örnekler tarafından çalıştırılan veritabanı altyapısının sürümü. |
| PayType | String | Hayır | Postpaid | Örneklerin faturalandırma yöntemi. Geçerli değerler:
|
| ConnectionMode | String | Hayır | Standard | Örneklerin bağlantı modu. Geçerli değerler:
Bu işlem varsayılan olarak desteklenen bağlantı modlarından herhangi birinde çalışan örnekleri döndürür. |
| Tags | String | Hayır | {"key1":"value1"} | Örneğe eklenen etiketler. Her etiket, TagKey ve TagValue olmak üzere iki bölümden oluşan bir anahtar-değer çiftidir. Her istek için maksimum beş etiketi şu biçimde belirtebilirsiniz: {"key1":"value1","key2":"value2"...}. |
| DedicatedHostGroupId | String | Hayır | dhg-7a9xxxxxxxx | Örneklerin ait olduğu özel kümenin kimliği. |
| DedicatedHostId | String | Hayır | i-bpxxxxxxx | Belirtilen özel kümede örneklerin üzerinde barındığı ana bilgisayarın kimliği. |
| InstanceLevel | Integer | Hayır | 0 | Category parametresini kullanarak örneklerin RDS sürümlerinin döndürülüp döndürülmeyeceğini belirtir. Geçerli değerler:
|
| ConnectionString | String | Hayır | rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com | Örneğin uç noktası. Bu parametreyi yalnızca tek bir örneği sorgulamak istediğinizde belirtmeniz gerekir. |
| NextToken | String | Hayır | o7PORW5o2TJg********** | Sonraki sayfayı görüntülemek için kullanılan belirteç. Bu parametreyi, DescribeDBInstances işlemine yapılan en son çağrıda NextToken parametresi için döndürülen değere ayarlamanız gerekir. Döndürülen girişler birden fazla sayfada görüntüleniyorsa bu parametre belirtilerek işlem tekrar çağrıldığında sonraki sayfa görüntülenebilir. |
| MaxResults | Integer | Hayır | 30 | Her sayfada döndürülecek giriş sayısı. Geçerli değerler: 1 ile 100. Varsayılan değer: 30. Not Bu parametreyi belirtirseniz PageSize parametresi ve PageNumber parametresi kullanılamaz. |
Yanıt parametreleri
| Parametre | Tür | Örnek | Açıklama |
| RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | İsteğin kimliği. |
| PageNumber | Integer | 1 | Döndürülen sayfanın sayfa numarası. Not MaxResults parametresini veya NextToken parametresini belirtirseniz yalnızca 1 değeri döndürülür. 1 değerini yok sayabilirsiniz. |
| PageRecordCount | Integer | 10 | Geçerli sayfada döndürülen giriş sayısı. |
| TotalRecordCount | Integer | 100 | Döndürülen toplam giriş sayısı. Not MaxResults parametresini veya NextToken parametresini belirtirseniz yalnızca geçerli sayfadaki giriş sayısı döndürülür. Sayıyı yok sayabilirsiniz. |
| Items | Array of DBInstance | Örneklerin ayrıntıları. | |
| DBInstance | |||
| VpcId | String | vpc-uf6f7l4fg90xxxxxxx | Örneğin ait olduğu VPC'nin kimliği. |
| DedicatedHostIdForLog | String | dh-bpxxxx | Günlük kaydı örneğinin üzerinde barındığı ana bilgisayarın kimliği. |
| CreateTime | String | 2018-11-05T11:26:02Z | Örneğin oluşturulduğu saat. Saat, yyyy-MM-ddTHH:mm:ssZ biçiminde ISO 8601 standardını izler. Saat UTC olarak görüntülenir. |
| PayType | String | Postpaid | Örneğin faturalandırma yöntemi. Geçerli değerler:
|
| DedicatedHostNameForLog | String | testlog | Günlük kaydı örneğinin üzerinde barındığı ana bilgisayarın adı. |
| MutriORsignle | Boolean | true | Örnek için çoklu alan dağıtım yönteminin kullanılıp kullanılmadığını gösterir. Geçerli değerler: true ve false. Not Örnek için çoklu alan dağıtım yöntemi kullanılıyorsa örneğin alan kimliği MAZ içerir. Örnek: cn-hangzhou-MAZ10(h,i). |
| DedicatedHostGroupName | String | testhostgroup | Örneğin ait olduğu özel kümenin adı. |
| EngineVersion | String | 5,7 | Örnek tarafından çalıştırılan veritabanı altyapısının sürümü. |
| DedicatedHostGroupId | String | dhg-7a9xxxxxxxx | Örneğin ait olduğu özel kümenin kimliği. |
| VpcName | String | test-huadong | Örneğin ait olduğu VPC'nin adı. |
| DedicatedHostZoneIdForMaster | String | cn-hangzhou-c | Birincil örneğin ait olduğu alanın kimliği. |
| ConnectionString | String | rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com | Örneğin uç noktası. |
| InstanceNetworkType | String | Classic | Örneğin ağ türü. Geçerli değerler:
|
| MasterInstanceId | String | rm-uf6wjk5xxxxxxxxxx | Birincil örneğin kimliği. Bu parametrenin değeri null ise örnek bir birincil örnektir. |
| ExpireTime | String | 2019-02-27T16:00:00Z | Örneğin süresinin dolduğu saat. Saat, yyyy-MM-ddTHH:mm:ssZ biçiminde ISO 8601 standardını izler. Saat UTC olarak görüntülenir. Not Kullandıkça öde örneklerinin süresi asla dolmaz. |
| DestroyTime | String | 2018-11-05T11:26:02Z | Örneğin yok edildiği saat. Saat, yyyy-MM-ddTHH:mm:ssZ biçiminde ISO 8601 standardını izler. Saat UTC olarak görüntülenir. |
| GuardDBInstanceId | String | rm-uf64zsuxxxxxxxxxx | Olağanüstü durum kurtarma örneğinin kimliği. Bu parametre yalnızca örnek bir birincil örnek olduğunda ve bir olağanüstü durum kurtarma örneğine sahip olduğunda döndürülür. |
| DedicatedHostNameForMaster | String | testmaster | Birincil örneğin üzerinde barındığı ana bilgisayarın adı. |
| ZoneId | String | cn-hangzhou-a | Örneğin ait olduğu alanın kimliği. |
| DBInstanceId | String | rm-uf6wjk5xxxxxxxxxx | Örneğin kimliği. |
| DedicatedHostIdForMaster | String | dh-bpxxxx | Birincil örneğin üzerinde barındığı ana bilgisayarın kimliği. |
| TempDBInstanceId | String | rm-uf64zsuxxxxxxxxxx | Geçici örneğin kimliği. Bu parametre yalnızca örnek bir birincil örnek olduğunda ve bir geçici örneğe sahip olduğunda döndürülür. |
| DBInstanceStorageType | String | ModuleList.4.ModuleCode | Örneğin depolama türü. |
| ConnectionMode | String | Standard | Örneğin bağlantı modu. Geçerli değerler:
|
| LockMode | String | Unlock | Örneğin kilitli olup olmadığını gösterir. Geçerli değerler:
|
| VpcCloudInstanceId | String | rm-uf6wjk5xxxxxxx | Örneğin kimliği. Bu parametre yalnızca örnek bir VPC'de bulunduğunda döndürülür. |
| DedicatedHostZoneIdForSlave | String | cn-hangzhou-d | İkincil örneğin ait olduğu alanın kimliği. |
| DedicatedHostZoneIdForLog | String | cn-hangzhou-b | Günlük kaydı örneğinin üzerinde barındığı ana bilgisayarın alan kimliği. |
| DedicatedHostNameForSlave | String | testslave | İkincil örneğin üzerinde barındığı ana bilgisayarın adı. |
| DBInstanceDescription | String | testdatabase | Örneğin açıklaması. |
| DBInstanceNetType | String | Internet | Örneğe yönelik ağ bağlantısının türü. Geçerli değerler:
|
| DBInstanceType | String | Primary | Örneğin rolü. Geçerli değerler:
|
| LockReason | String | instance_expired | Örneğin kilitlenme nedeni. |
| DBInstanceStatus | String | Running | Örneğin durumu. Daha fazla bilgi için bkz. Örnek durum tablosu. |
| RegionId | String | cn-hangzhou | Örneğin bölge kimliği. |
| VSwitchId | String | vsw-uf6adz52c2pxxxxxxx | vSwitch kimliği. |
| DedicatedHostIdForSlave | String | dh-bpxxxx | İkincil örneğin üzerinde barındığı ana bilgisayarın kimliği. |
| ResourceGroupId | String | rg-acfmyxxxxxxx | Örneğin ait olduğu kaynak grubunun kimliği. |
| Category | String | Basic | Örneğin RDS sürümü. Geçerli değerler:
|
| Engine | String | MySQL | Örnek tarafından çalıştırılan veritabanı altyapısı. |
| DBInstanceClass | String | rds.mys2.small | Örneğin örnek türü. Bilgi için bkz. Birincil ApsaraDB RDS örnek türleri. |
| ReadOnlyDBInstanceIds | Array of ReadOnlyDBInstanceId | Örneğe ekli salt okunur örneklerin kimliklerinden oluşan bir dizi. Bu parametre yalnızca örnek bir birincil örnek olduğunda ve salt okunur örneklere sahip olduğunda döndürülür. | |
| ReadOnlyDBInstanceId | |||
| DBInstanceId | String | rr-uf6wjk5xxxxxxx | Salt okunur örneğin kimliği. |
| DeletionProtection | Boolean | false | Salt okunur örnek için silme koruma özelliğinin etkin olup olmadığını gösterir. Geçerli değerler:
|
| NextToken | String | o7PORW5o2TJg********** | Sonraki sayfayı görüntülemek için kullanılan belirteç. Döndürülen girişler birden fazla sayfada görüntüleniyorsa NextToken parametresi belirtilerek işlem tekrar çağrıldığında sonraki sayfa görüntülenebilir. |
Örnekler
Örnek istekler
http(s)://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<Common request parameters>
Başarılı yanıt örnekleri
XML biçimi
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstancesResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>1</PageRecordCount>
<RequestId>A436D75C-30B0-1F34-8544-4B46F4407CC1</RequestId>
<NextToken>o7PORW5owHNg**********</NextToken>
<PageNumber>1</PageNumber>
<Items>
<DBInstance>
<EngineVersion>10.0</EngineVersion>
<ZoneId>cn-hangzhou-h</ZoneId>
<DBInstanceStatus>Running</DBInstanceStatus>
<ResourceGroupId>rg-acfmyiu********</ResourceGroupId>
<DBInstanceNetType>Intranet</DBInstanceNetType>
<DBInstanceClass>pg.n2.small.2c</DBInstanceClass>
<CreateTime>2021-02-02T09:14:48Z</CreateTime>
<VSwitchId>vsw-bp10aqj6o4lcl********</VSwitchId>
<TipsLevel>0</TipsLevel>
<DBInstanceType>Primary</DBInstanceType>
<PayType>Prepaid</PayType>
<LockMode>Unlock</LockMode>
<DeletionProtection>false</DeletionProtection>
<MutriORsignle>false</MutriORsignle>
<InstanceNetworkType>VPC</InstanceNetworkType>
<InsId>1</InsId>
<VpcId>vpc-bp1opxu1zkhn0********</VpcId>
<DBInstanceId>pgm-bp10re7n********</DBInstanceId>
<ConnectionMode>Standard</ConnectionMode>
<ReadOnlyDBInstanceIds>
</ReadOnlyDBInstanceIds>
<VpcCloudInstanceId>pgm-bp10re7n********</VpcCloudInstanceId>
<RegionId>cn-hangzhou</RegionId>
<ConnectionString>pgm-bp10re7n**************.pg.rds.aliyuncs.com</ConnectionString>
<ExpireTime>2021-02-03T09:14:48Z</ExpireTime>
<Engine>PostgreSQL</Engine>
</DBInstance>
</Items>
</DescribeDBInstancesResponse>
JSON biçimi
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalRecordCount" : 1,
"PageRecordCount" : 1,
"RequestId" : "A436D75C-30B0-1F34-8544-4B46F4407CC1",
"NextToken" : "o7PORW5owHNg**********",
"PageNumber" : 1,
"Items" : {
"DBInstance" : [ {
"EngineVersion" : "10.0",
"ZoneId" : "cn-hangzhou-h",
"DBInstanceStatus" : "Running",
"ResourceGroupId" : "rg-acfmyiu********",
"DBInstanceNetType" : "Intranet",
"DBInstanceClass" : "pg.n2.small.2c",
"CreateTime" : "2021-02-02T09:14:48Z",
"VSwitchId" : "vsw-bp10aqj6o4lcl********",
"TipsLevel" : 0,
"DBInstanceType" : "Primary",
"PayType" : "Prepaid",
"LockMode" : "Unlock",
"DeletionProtection" : false,
"MutriORsignle" : false,
"InstanceNetworkType" : "VPC",
"InsId" : 1,
"VpcId" : "vpc-bp1opxu1zkhn0********",
"DBInstanceId" : "pgm-bp10re7n********",
"ConnectionMode" : "Standard",
"ReadOnlyDBInstanceIds" : {
"ReadOnlyDBInstanceId" : [ ]
},
"VpcCloudInstanceId" : "pgm-bp10re7n********",
"RegionId" : "cn-hangzhou",
"ConnectionString" : "pgm-bp10re7n**************.pg.rds.aliyuncs.com",
"ExpireTime" : "2021-02-03T09:14:48Z",
"Engine" : "PostgreSQL"
} ]
}
}
Hata kodları
| HTTP durum kodu | Hata kodu | Hata iletisi | Açıklama |
| 400 | Invalid.NextToken | The parameter NextToken is invalid. | NextToken parametresinin değeri geçersiz olduğu için döndürülen hata iletisi. |
| 400 | InvalidDBInstanceType.ValueNotSupport | The specified parameter"DBInstanceType" is not valid. | Belirtilen örnek türü geçersiz olduğu için döndürülen hata iletisi. Geçerli bir örnek türü belirtmeniz gerekir. |
Hata kodlarının listesi için Hata Merkezi adresini ziyaret edin.