Tüm Ürünler
Search

Bu Ürün

    :DescribeDBInstances

    Belge Merkezi

    :DescribeDBInstances

    Son Güncelleme:Sep 30, 2026

    MongoDB örneklerinin listesini sorgular.

    Operation description

    Varsayılan olarak, bu işlem replika kümesi örneklerinin (tek düğümlü örnekler dahil) listesini sorgular. DBInstanceType istek parametresi belirtilmezse, bu parametrenin varsayılan değeri replicate olur. Parçalanmış küme örneklerinin listesini sorgulamak için DBInstanceType parametresini sharding olarak ayarlayın.

    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

    dds:DescribeDBInstances

    get

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/*

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    Bölge kimliği. Bölge kimliğini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.

    cn-hangzhou
    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.

    1
    PageSize

    integer

    No

    Her sayfadaki giriş sayısı. Geçerli değerler:

    • 30 (varsayılan)

    • 50

    • 100

    Valid values:

    • 30 :

      Sayfa başına 30 giriş.

    • 50 :

      Sayfa başına 50 giriş.

    • 100 :

      Sayfa başına 100 giriş.

    30
    DBInstanceId

    string

    No

    Örnek kimliği.

    dds-bp199659b178****
    ReplicationFactor

    string

    No

    Replika kümesi örneğindeki düğüm sayısı. Geçerli değerler:

    • 3

    • 5

    • 7

    3
    DBInstanceDescription

    string

    No

    Örnek adı. Ad aşağıdaki gereksinimleri karşılamalıdır:

    • Bir Çince karakter veya harfle başlamalıdır.

    • Rakamlar, Çince karakterler, harfler, alt çizgiler (_) ve tireler (-) içerebilir.

    • Uzunluğu 2 ila 256 karakter arasında olmalıdır.

    TestDatabase
    ExpireTime

    string

    No

    Örneğin yyyy-MM-ddTHH:mm:ssZ formatındaki (UTC) sona erme zamanı. Bu parametre, sona erme zamanı belirtilen zamandan önce veya ona eşit olan örnekleri filtrelemek için kullanılır.

    2019-12-26T16:00:00Z
    DBInstanceStatus

    string

    No

    Örnek durumu. Geçerli değerler hakkında daha fazla ayrıntı için Örnek durum tablosu sayfasına bakın.

    Running
    DBInstanceType

    string

    No

    Örnek türü. Geçerli değerler:

    • sharding: Parçalanmış küme örneği.

    • replicate: Varsayılan değer. Replika kümesi örneği veya tek düğümlü örnek.

    sharding
    DBInstanceClass

    string

    No

    Örnek teknik özellikleri. Geçerli değerler hakkında daha fazla bilgi için Örnek teknik özellikleri sayfasına bakın.

    dds.mongo.mid
    Engine

    string

    No

    Veritabanı motoru. Değeri MongoDB olarak ayarlayın.

    Valid values:

    • MongoDB :

      MongoDB veritabanı motoru.

    MongoDB
    EngineVersion

    string

    No

    Veritabanı motoru sürümü. Geçerli değerler:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.0
    NetworkType

    string

    No

    Örneğin ağ türü. Geçerli değerler:

    • Classic: Klasik ağ.

    • VPC: VPC.

    VPC
    VpcId

    string

    No

    VPC kimliği.

    vpc-bp1n3i15v90el48nx****
    VSwitchId

    string

    No

    VPC'nin vSwitch kimliği.

    vsw-bp1vj604nj5a9zz74****
    ChargeType

    string

    No

    Örneğin faturalandırma yöntemi. Geçerli değerler:

    • PrePaid: Abonelik.

    • PostPaid: Kullandıkça öde.

    PrePaid
    ZoneId

    string

    No

    Kullanılabilirlik bölgesi kimliği. Kullanılabilirlik bölgesi kimliğini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.

    cn-hangzhou-b
    Expired

    string

    No

    Örneğin sona erme durumu. Geçerli değerler:

    • true: Sona ermiş.

    • false: Sona ermemiş.

    true
    ConnectionDomain

    string

    No

    Düğümün uç noktası. Uç noktayı sorgulamak için DescribeDBInstanceAttribute işlemini çağırabilirsiniz.

    dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
    ResourceGroupId

    string

    No

    Kaynak grubu kimliği.

    rg-acfmyiu4ekp****
    Tag

    array<object>

    No

    Etiketler.

    object

    No

    Key

    string

    No

    Örneğin etiket anahtarı. N için geçerli değerler: 1 ile 20 arası.

    • Etiket anahtarı aliyun, acs:, http:// veya https:// ile başlayamaz.

    • Etiket anahtarının uzunluğu en fazla 64 karakter olabilir.

    • Etiket anahtarı boş bir dize olamaz.

    testdatabase
    Value

    string

    No

    Örneğin etiket değeri. N için geçerli değerler: 1 ile 20 arası.

    • Etiket değeri aliyun, acs:, http:// veya https:// ile başlayamaz.

    • Etiket değerinin uzunluğu en fazla 128 karakter olabilir.

    • Etiket değeri boş bir dize olabilir.

    apitest
    DBNodeType

    string

    No

    Standart veya test örneklerinin filtrelenip filtrelenmeyeceğini belirtir.

    1. Tek düğümlü örnekler ve DBFS örnekleri: customized

    2. Standart örnekler (replika kümesi ve parçalanmış küme): standard

    3. Varsayılan (tüm örnekleri gösterir): default

    default

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    Sorgu sonucundaki örnek sayısı.

    5
    RequestId

    string

    İstek kimliği.

    0E4FE33F-5510-5758-8FA7-A6672CDE****
    PageSize

    integer

    Her sayfadaki kayıt sayısı.

    30
    PageNumber

    integer

    Sayfa numarası.

    1
    DBInstances

    object

    DBInstance

    array<object>

    Örnek bilgilerinin listesi.

    array<object>

    CreationTime

    string

    Örneğin oluşturulduğu zaman. Zaman, yyyy-MM-ddTHH:mm:ssZ formatındadır (UTC).

    2021-03-25T02:18:00Z
    ChargeType

    string

    Örneğin faturalandırma yöntemi. Geçerli değerler:

    • PrePaid: Abonelik.

    • PostPaid: Kullandıkça öde.

    PrePaid
    Tags

    object

    Tag

    array<object>

    Kaynak etiketlerinin listesi.

    object

    Kaynak etiketlerinin listesi.

    Key

    string

    Kaynağın etiket anahtarı.

    test
    Value

    string

    Kaynağın etiket değeri.

    api
    VpcAuthMode

    string

    VPC üzerinden parolasız erişimin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • Open: Etkin.

    • Close: Devre dışı.

    Close
    NetworkType

    string

    Örneğin ağ türü. Geçerli değerler:

    • Classic: Klasik ağ.

    • VPC: VPC.

    Classic
    LockMode

    string

    Örneğin kilit durumu. Geçerli değerler:

    • Unlock: Örnek kilitli değil.

    • ManualLock: Örnek manuel olarak kilitlendi.

    • LockByExpiration: Örnek, süresi dolduğu için otomatik olarak kilitlendi.

    • LockByRestoration: Örnek, geri alma işleminden önce otomatik olarak kilitlendi.

    • LockByDiskQuota: Örnek, depolama alanı dolduğu için otomatik olarak kilitlendi.

    • Released: Örnek serbest bırakıldı. Bu durumda örneğin kilidi açılamaz. Yalnızca yedekleme verilerini kullanarak yeni bir örnek oluşturabilirsiniz. Yeniden oluşturma işlemi uzun zaman alır.

    Unlock
    EngineVersion

    string

    Veritabanı motoru sürümü. Geçerli değerler:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    MongosList

    object

    MongosAttribute

    array<object>

    Mongos düğümü bilgilerinin listesi.

    Not

    Bu parametre, örnek türü parçalanmış küme örneği olduğunda döndürülür.

    object

    Mongos düğümü bilgilerinin listesi.

    Not

    Bu parametre, örnek türü parçalanmış küme örneği olduğunda döndürülür.

    NodeClass

    string

    Mongos düğümünün teknik özellikleri.

    dds.mongos.standard
    NodeDescription

    string

    Mongos düğümünün açıklaması.

    Test mongos node
    NodeId

    string

    Mongos düğümünün kimliği.

    s-bp10e3b0d02f****
    DBInstanceDescription

    string

    Örneğin açıklaması veya notları.

    TestDatabase
    ExpireTime

    string

    Örneğin süresinin dolduğu zaman. Zaman, yyyy-MM-ddTHH:mmZ formatındadır (UTC).

    2021-11-25T16:00Z
    DBInstanceType

    string

    Örnek türü. Geçerli değerler:

    • sharding: Parçalanmış küme örneği.

    • replicate: Replika kümesi örneği veya bağımsız örnek.

    sharding
    LastDowngradeTime

    string

    Örneğin son düşürülme zamanı. Zaman YYYY-MM-DD formatındadır.

    2021-05-08
    ShardList

    object

    ShardAttribute

    array<object>

    Parça düğümü bilgilerinin listesi.

    Not

    Bu parametre, örnek türü parçalanmış küme örneği olduğunda döndürülür.

    object

    Parça düğümü bilgilerinin listesi.

    Not

    Bu parametre, örnek türü parçalanmış küme örneği olduğunda döndürülür.

    NodeClass

    string

    Parça düğümünün teknik özellikleri.

    dds.shard.mid
    NodeDescription

    string

    Parça düğümünün açıklaması.

    Test shard node
    NodeStorage

    integer

    Parça düğümünün depolama kapasitesi. Birim: GB.

    10
    NodeId

    string

    Parça düğümünün kimliği.

    d-bp1cac6f2083****
    ReadonlyReplicas

    integer

    Parça düğümündeki salt okunur düğüm sayısı. Geçerli değerler: 0 ile 5 arası.

    2
    DestroyTime

    string

    Örneğin verilerinin silinme zamanı. Zaman, yyyy-MM-ddTHH:mm:ssZ formatındadır (UTC).

    Not

    • Abonelik örneklerinde, örneğin süresi dolduktan 16 gün sonra işlem kaynakları serbest bırakılır ve veriler 7 gün daha saklanır. Örneğin süresi dolduktan 23 gün sonra veriler silinir ve kurtarılamaz.

    • Kullandıkça öde örneklerinde, örneğin ödemesi geciktikten 16 gün sonra işlem kaynakları serbest bırakılır ve veriler 7 gün daha saklanır. Ödeme gecikmesinden 23 gün sonra veriler silinir ve kurtarılamaz.

    2021-12-10T16:00:00Z
    DBInstanceStatus

    string

    Örnek durumu. Ayrıntılar için Örnek durum tablosu sayfasına bakın.

    Running
    RegionId

    string

    Örneğin bölge kimliği.

    cn-hangzhou
    DBInstanceStorage

    integer

    Örnek depolama kapasitesi.

    20
    ResourceGroupId

    string

    Kaynak grubu kimliği.

    rg-acfmyiu4ekp****
    ZoneId

    string

    Örneğin kullanılabilirlik bölgesi kimliği.

    cn-hangzhou-g
    DBInstanceId

    string

    Örnek kimliği.

    dds-bp18b0934e70****
    DBInstanceClass

    string

    Örnek sınıfı.

    dds.mongo.mid
    Engine

    string

    Veritabanı motoru.

    MongoDB
    ReplicationFactor

    string

    Örnekteki düğüm sayısı.

    Not

    Bu parametre, örnek türü replika kümesi örneği olduğunda döndürülür.

    3
    KindCode

    string

    Örneğin türü. Geçerli değerler:

    • 0: Fiziksel makine.

    • 1: ECS.

    • 2: DOCKER.

    • 18: Kubernetes tabanlı yeni mimari örneği.

    1
    CapacityUnit

    string

    Örnek tarafından tüketilen okuma/yazma aktarım hızı.

    Not

    Bu parametre, örnek türü Serverless örneği olduğunda döndürülür.

    100
    StorageType

    string

    Depolama türü. Geçerli değerler:

    • cloud_essd: ESSD bulut diski.

    • local_ssd: Yerel standart SSD.

    local_ssd
    BackupRetentionPolicy

    integer

    Yedekleme verisi saklama politikası. Geçerli değerler:

    • 0: Örnek serbest bırakıldığında tüm yedekleme kümeleri anında silinir.

    • 1: Örnek serbest bırakıldığında otomatik bir yedekleme gerçekleştirilir ve yedekleme kümesi uzun süreli saklama (LTR) için tutulur.

    • 2: Örnek serbest bırakıldığında otomatik bir yedekleme gerçekleştirilir ve kümenin tüm yedekleme kümeleri uzun süreli saklama (LTR) için tutulur.

    1
    ReleaseTime

    string

    Örneğin serbest bırakıldığı zaman. Zaman YYYY-MM-DDTHH:mmZ formatındadır (UTC).

    2024-06-17T07:01Z

    Examples

    Success response

    JSON format

    {
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "测试mongos节点",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "测试数据库",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "测试shard节点",
              "NodeStorage": 10,
              "NodeId": "d-bp1cac6f2083****",
              "ReadonlyReplicas": 2
            }
          ]
        },
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 20,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp18b0934e70****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "StorageType": "local_ssd",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.