Todos os produtos
Search

Este produto

    ApsaraDB for MongoDB:DescribeDBInstanceAttribute

    Central de documentação

    ApsaraDB for MongoDB:DescribeDBInstanceAttribute

    Última atualização: Jun 28, 2026

    Consulta informações sobre uma instância do ApsaraDB for MongoDB.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    dds:DescribeDBInstanceAttribute

    get

    *dbinstance

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

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    Engine

    string

    Não

    O mecanismo de banco de dados. Valor válido: MongoDB.

    MongoDB
    DBInstanceId

    string

    Sim

    O ID da instância.

    dds-bp11483712c1****
    ResourceGroupId

    string

    Não

    O ID do grupo de recursos. Para mais informações, consulte Visualizar informações básicas sobre um grupo de recursos.

    Nota

    Este parâmetro é suportado apenas no site da Alibaba Cloud na China (www.aliyun.com).

    rg-acfmyiu4ekp****
    IsDelete

    boolean

    Não

    Indica se a instância foi excluída. Valores válidos:

    • false: A instância está em execução normal. Consulta informações sobre uma instância em execução.

    • true: A instância foi excluída. Consulta informações sobre uma instância excluída.

    false

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Informações detalhadas sobre a instância.

    RequestId

    string

    O ID da solicitação.

    A935A8EE-A6CC-53DE-98BA-20ABAA7E632B
    DBInstances

    object

    DBInstance

    array<object>

    Informações detalhadas sobre a instância.

    array<object>

    Informações detalhadas sobre a instância.

    CreationTime

    string

    The time when the instance was created. The time follows the yyyy-MM-ddTHH:mm:ssZ format in UTC.

    2022-01-02T07:43:59Z
    ReplicaSets

    object

    ReplicaSet

    array<object>

    Information about replica set instances.

    Nota

    This parameter is returned only when the instance type is replica set.

    object

    Information about replica set instances.

    Nota

    This parameter is returned only when the instance type is replica set.

    VSwitchId

    string

    The ID of the vSwitch.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    vpc-bp1jk5vwkcri27qme****
    ConnectionPort

    string

    The connection port of the node.

    3717
    ReplicaSetRole

    string

    The role of the node. Valid values:

    • Primary: primary node.

    • Secondary: secondary node.

    Primary
    ConnectionDomain

    string

    The connection address of the node.

    dds-bp11483712c1****.mongodb.rds.aliyuncs.com
    VPCCloudInstanceId

    string

    The VPC instance ID of the replica set node.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    dds-bp11483712c1****
    NetworkType

    string

    The network type. Valid values:

    • Classic: classic network.

    • VPC: virtual private cloud (VPC).

    VPC
    VPCId

    string

    The ID of the VPC.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    vpc-bp1jk5vwkcri27qme****
    ReplacateId

    string

    The logical ID of the Global Distributed Cache instance.

    Nota

    MongoDB no longer supports purchasing this type of instance. This parameter applies only to legacy Global Distributed Cache instances.

    bls-m****
    Tags

    object

    Tag

    array<object>

    The list of tags for the instance.

    object

    The list of tags for the instance.

    Key

    string

    The tag key of the instance.

    test
    Value

    string

    The tag value of the instance.

    api
    VpcAuthMode

    string

    The password-free access mode over the internal network. Valid values:

    • Open: Password-free access over the internal network is enabled.

    • Close: Password-free access over the internal network is disabled. You must use a password to access the instance.

    • NotSupport: This feature is not supported.

    Open
    NetworkType

    string

    The network type of the instance. Valid values:

    • Classic: classic network.

    • VPC: virtual private cloud (VPC).

    VPC
    LockMode

    string

    The lock status of the instance. Valid values:

    • Unlock: The instance is normal and unlocked.

    • ManualLock: The instance is manually locked.

    • LockByExpiration: The instance is automatically locked after expiration.

    • LockByRestoration: The instance is automatically locked before rollback.

    • LockByDiskQuota: The instance is automatically locked when its storage space is full.

    Unlock
    EngineVersion

    string

    The major version of the database.

    4.4
    MaxIOPS

    integer

    The maximum IOPS of the instance.

    1000
    MaxMBPS

    integer

    The maximum disk throughput of the instance. Unit: MB/s.

    350
    VPCCloudInstanceIds

    string

    The ID of the VPC instance.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    Importante This parameter is deprecated.

    dds-bp11483712c1****
    MongosList

    object

    MongosAttribute

    array<object>

    The list of Mongos node information.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    object

    The list of Mongos node information.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    VpcCloudInstanceId

    string

    The VPC instance ID of the Mongos node.

    s-bp1d8c262a158****
    LockMode

    string

    The lock status of the instance. Valid values:

    • Unlock: normal.

    • ManualLock: manually locked.

    • LockByExpiration: automatically locked after expiration.

    • LockByRestoration: automatically locked before rollback.

    • LockByDiskQuota: automatically locked when storage space is full.

    Unlock
    MaxIOPS

    integer

    The maximum IOPS of the Mongos node.

    800
    VSwitchId

    string

    The ID of the vSwitch.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    vsw-bp1vj604nj5a9zz74****
    NodeClass

    string

    The specifications of the Mongos node.

    dds.mongos.mid
    MaxConnections

    integer

    The maximum number of connections for the Mongos node.

    1000
    Port

    integer

    The connection port of the Mongos node.

    3717
    VPCId

    string

    The ID of the VPC.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    vpc-bp1n3i15v90el48nx****
    ConnectSting

    string

    The connection address of the Mongos node.

    Aviso This parameter will be deprecated soon. Use the ConnectString parameter instead.

    s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
    NodeDescription

    string

    The name of the Mongos node.

    mongos1
    NodeId

    string

    The ID of the Mongos node.

    s-bp1d8c262a15****
    Status

    string

    The status of the Mongos node. For more information, see Instance status table.

    Running
    CurrentKernelVersion

    string

    The current minor kernel version of the MongoDB node.

    mongodb_20220518_4.0.21
    ConnectString

    string

    The connection address of the Mongos node.

    s-bp1d8c262a15****.mongodb.rds.aliyuncs.com
    ProtocolType

    string

    The protocol type used to access the instance. Valid values:

    • mongodb: MongoDB protocol.

    • dynamodb: DynamoDB protocol.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    mongodb
    DBInstanceDescription

    string

    The name of the instance.

    Test database
    CurrentKernelVersion

    string

    The current minor version of the database.

    5.0.5-20220721143518_0
    DBInstanceReleaseProtection

    boolean

    Indicates whether release protection is enabled for the instance. Valid values:

    • true: enabled.

    • false: disabled.

    false
    ExpireTime

    string

    The expiration time of a subscription instance. The time follows the yyyy-MM-ddTHH:mmZ format in UTC.

    Nota

    This parameter is returned only when the billing method is subscription.

    2022-02-05T16:00Z
    MaintainStartTime

    string

    The start time of the maintenance window for the instance. The time follows the HH:mmZ format in UTC.

    18:00Z
    DBInstanceType

    string

    The type of the instance. Valid values:

    • replicate: replica set instance.

    • sharding: sharded cluster instance.

    replicate
    LastDowngradeTime

    string

    The last time when the instance specifications were downgraded.

    2022-01-08
    ShardList

    object

    ShardAttribute

    array<object>

    The list of shard node information.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    object

    The list of shard node information.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    LockMode

    string

    The lock mode of the cluster. Valid values:

    • Unlock: normal.

    • ManualLock: manually locked.

    • LockByExpiration: automatically locked after expiration.

    • LockByRestoration: automatically locked before rollback.

    • LockByDiskQuota: automatically locked when storage space is full.

    Unlock
    MaxIOPS

    integer

    The maximum IOPS of the shard node.

    8000
    ConnectString

    string

    The connection address of the shard node.

    d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****
    NodeClass

    string

    The specifications of the shard node.

    dds.shard.mid
    MaxConnections

    integer

    The maximum number of connections for the shard node.

    8000
    Port

    integer

    The port of the shard node.

    3717
    NodeDescription

    string

    The name of the shard node.

    testshard
    NodeId

    string

    The ID of the shard node.

    d-bp16e09d9c5d****
    NodeStorage

    integer

    The storage capacity of the shard node. Unit: GB.

    10
    ReadonlyReplicas

    integer

    The number of read-only nodes in the shard node. Valid values: 0 to 5.

    0
    Status

    string

    The status of the shard node. For more information, see Instance status table.

    Running
    MaxDiskMbps

    string

    The maximum disk throughput of the shard node.

    350
    CurrentKernelVersion

    string

    The current minor kernel version of the MongoDB node.

    mongodb_20220518_4.0.21
    ReplicaSetName

    string

    The name of the shard node.

    mgset-xxxx
    MaintainEndTime

    string

    The end time of the maintenance window for the instance. The time follows the HH:mmZ format in UTC.

    03:00Z
    DBInstanceStatus

    string

    The status of the instance. For more information, see Instance status table.

    Running
    VPCId

    string

    The ID of the VPC.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    vpc-bp1n3i15v90el48nx****
    RegionId

    string

    The region ID of the instance.

    cn-hangzhou
    DBInstanceStorage

    integer

    The storage capacity of the instance.

    10
    ReplicaSetName

    string

    The name of the replica set instance.

    Nota

    This parameter is returned only when the instance type is replica set.

    mgset-10ace****
    VSwitchId

    string

    The ID of the vSwitch.

    Nota

    This parameter is returned only when the network type of the instance is VPC.

    vsw-bp1oo2a7isyrb8igf****
    StorageEngine

    string

    The storage engine type of the instance.

    WiredTiger
    ConfigserverList

    object

    ConfigserverAttribute

    array<object>

    The list of Configserver node information.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    object

    The list of Configserver node information.

    Nota

    This parameter is returned only when the instance type is sharded cluster.

    MaxIOPS

    integer

    The maximum IOPS of the Configserver node.

    1000
    LockMode

    string

    The lock status of the instance. Valid values:

    • Unlock: normal.

    • ManualLock: manually locked.

    • LockByExpiration: automatically locked after expiration.

    • LockByRestoration: automatically locked before rollback.

    • LockByDiskQuota: automatically locked when storage space is full.

    Unlock
    ConnectString

    string

    The connection address of the Configserver node.

    dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com
    NodeClass

    string

    The specifications of the Configserver node.

    dds.cs.mid
    MaxConnections

    integer

    The maximum number of connections for the Configserver node.

    1000
    Port

    integer

    The port of the Configserver node.

    3717
    NodeDescription

    string

    The name of the Configserver node.

    testConfigserver
    NodeId

    string

    The ID of the Configserver node.

    dds-bp11483712c1****-cs
    NodeStorage

    integer

    The storage capacity of the Configserver node. Unit: GB.

    20
    Status

    string

    The status of the ConfigServer node. For more information, see Instance status table.

    Running
    CurrentKernelVersion

    string

    The current minor kernel version of the MongoDB node.

    mongodb_20220518_4.0.21
    ResourceGroupId

    string

    The ID of the resource group to which the instance belongs.

    Nota

    This parameter is returned only on Alibaba Cloud China Website (www.aliyun.com).

    rg-acfmyiu4ekp****
    ZoneId

    string

    The zone ID of the instance.

    cn-hangzhou-b
    MaxConnections

    integer

    The maximum number of connections for the instance.

    500
    DBInstanceId

    string

    The ID of the instance.

    dds-bp11483712c1****
    DBInstanceClass

    string

    The instance type.

    dds.mongo.mid
    Engine

    string

    The database engine.

    MongoDB
    ReadonlyReplicas

    string

    The number of read-only nodes for the instance.

    1
    ReplicationFactor

    string

    The number of nodes in the instance.

    Nota

    This parameter is returned only when the instance type is replica set.

    3
    KindCode

    string

    The type of the instance. Valid values:

    • 0: local disk instance.

    • 3: standalone instance.

    • 18: cloud disk instance.

    18
    CapacityUnit

    string

    The read and write throughput consumed by the instance.

    100
    ChargeType

    string

    The billing method of the instance. Valid values:

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    PostPaid
    StorageType

    string

    The storage class. Valid values:

    cloud_essd1: ESSD PL1 cloud disk. cloud_essd2: ESSD PL2 cloud disk. cloud_essd3: ESSD PL3 cloud disk. local_ssd: SSD local disk. cloud_essd_dbfs_s: DBFS shared storage cloud disk.

    cloud_essd1
    DestroyTime

    string

    The time when instance data is destroyed. The time follows the yyyy-MM-ddTHH:mm:ssZ format in UTC.

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

    string

    The status of orders generated for the instance. Valid values:

    • all_completed: All orders are being processed or have been completed.

    • order_unpaid: There are unpaid orders.

    • order_wait_for_produce: There are orders waiting to be processed.

    Nota

    The order processing flow includes placing an order, paying for the order, issuing the order for production, producing the order, and completing production.

    • If the order status remains order_wait_for_produce for a long time, the order issuance process has encountered an issue. The system will automatically retry.

    • The instance status changes only during or after order production, such as during specification changes or when running.

    all_completed
    Encrypted

    boolean

    Indicates whether disk encryption is enabled.

    true
    EncryptionKey

    string

    The KMS key used for disk encryption.

    07609cc3-3109-408f-a35e-c548e776da0b
    SyncPercent

    string

    The percentage of data synchronization progress. When the instance is undergoing specification changes, operations such as data synchronization occur. You can use this field to monitor the synchronization progress.

    0.8
    UseClusterBackup

    boolean

    Indicates whether cluster backup mode is enabled. Valid values:

    • true: Cluster backup mode is enabled.

    • false: Cluster backup mode is disabled.

    true
    BurstingEnabled

    boolean

    Indicates whether burst performance is enabled.

    true
    ProvisionedIops

    integer

    The provisioned performance.

    1960
    DisasterRecoveryInfo

    string

    Information about source and destination instances for Global Distributed Cache.

    {"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]}
    SearchNodeClass

    string

    The specifications of the Search node for specification changes.

    mdb.shard.2x.xlarge.d
    SearchNodeStorage

    integer

    The capacity of the Search node for specification changes.

    20
    SearchNodeCount

    integer

    The number of Search nodes for specification changes.

    2
    ColdDataEnabled

    boolean

    ShardSearchNodes

    object

    ShardSearchNodes

    array<object>

    object

    NodeId

    string

    SearchNodeId

    string

    SearchNodeClass

    string

    SearchNodeStorage

    string

    SearchNodeCount

    string

    AIGatewayEnabled

    boolean

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "ReplicaSets": {
          "ReplicaSet": [
            {
              "VSwitchId": "vpc-bp1jk5vwkcri27qme****",
              "ConnectionPort": "3717",
              "ReplicaSetRole": "Primary",
              "ConnectionDomain": "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
              "VPCCloudInstanceId": "dds-bp11483712c1****",
              "NetworkType": "VPC",
              "VPCId": "vpc-bp1jk5vwkcri27qme****"
            }
          ]
        },
        "ReplacateId": "bls-m****",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Open",
        "NetworkType": "VPC",
        "LockMode": "Unlock",
        "EngineVersion": "4.4",
        "MaxIOPS": 1000,
        "MaxMBPS": 350,
        "VPCCloudInstanceIds": "dds-bp11483712c1****",
        "MongosList": {
          "MongosAttribute": [
            {
              "VpcCloudInstanceId": "s-bp1d8c262a158****",
              "LockMode": "Unlock",
              "MaxIOPS": 800,
              "VSwitchId": "vsw-bp1vj604nj5a9zz74****",
              "NodeClass": "dds.mongos.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "VPCId": "vpc-bp1n3i15v90el48nx****",
              "ConnectSting": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
              "NodeDescription": "mongos1",
              "NodeId": "s-bp1d8c262a15****",
              "Status": "Running",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ConnectString": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com"
            }
          ]
        },
        "ProtocolType": "mongodb",
        "DBInstanceDescription": "Test database",
        "CurrentKernelVersion": "5.0.5-20220721143518_0",
        "DBInstanceReleaseProtection": false,
        "ExpireTime": "2022-02-05T16:00Z",
        "MaintainStartTime": "18:00Z",
        "DBInstanceType": "replicate",
        "LastDowngradeTime": "2022-01-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "LockMode": "Unlock",
              "MaxIOPS": 8000,
              "ConnectString": "d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****",
              "NodeClass": "dds.shard.mid",
              "MaxConnections": 8000,
              "Port": 3717,
              "NodeDescription": "testshard",
              "NodeId": "d-bp16e09d9c5d****",
              "NodeStorage": 10,
              "ReadonlyReplicas": 0,
              "Status": "Running",
              "MaxDiskMbps": "350",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ReplicaSetName": "mgset-xxxx"
            }
          ]
        },
        "MaintainEndTime": "03:00Z",
        "DBInstanceStatus": "Running",
        "VPCId": "vpc-bp1n3i15v90el48nx****",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 10,
        "ReplicaSetName": "mgset-10ace****",
        "VSwitchId": "vsw-bp1oo2a7isyrb8igf****",
        "StorageEngine": "WiredTiger",
        "ConfigserverList": {
          "ConfigserverAttribute": [
            {
              "MaxIOPS": 1000,
              "LockMode": "Unlock",
              "ConnectString": "dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com",
              "NodeClass": "dds.cs.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "NodeDescription": "testConfigserver",
              "NodeId": "dds-bp11483712c1****-cs",
              "NodeStorage": 20,
              "Status": "Running",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "MaxConnections": 500,
        "DBInstanceId": "dds-bp11483712c1****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReadonlyReplicas": "1",
        "ReplicationFactor": "3",
        "KindCode": "18",
        "CapacityUnit": "100",
        "ChargeType": "PostPaid",
        "StorageType": "cloud_essd1",
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceOrderStatus": "all_completed",
        "Encrypted": true,
        "EncryptionKey": "07609cc3-3109-408f-a35e-c548e776da0b",
        "SyncPercent": "0.8",
        "UseClusterBackup": true,
        "BurstingEnabled": true,
        "ProvisionedIops": 1960,
        "DisasterRecoveryInfo": "{\"relations\":[{\"destInsName\":\"dds-bp11483712c1****\",\"destRegionId\":\"cn-hangzhou\",\"srcInsName\":\"dds-7xv054b9c43c****\",\"srcRegionId\":\"cn-guangzhou\"}]}",
        "SearchNodeClass": "mdb.shard.2x.xlarge.d",
        "SearchNodeStorage": 20,
        "SearchNodeCount": 2,
        "ColdDataEnabled": false,
        "ShardSearchNodes": {
          "ShardSearchNodes": [
            {
              "NodeId": "",
              "SearchNodeId": "",
              "SearchNodeClass": "",
              "SearchNodeStorage": "",
              "SearchNodeCount": ""
            }
          ]
        },
        "AIGatewayEnabled": false
      }
    ]
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 VpcCloudInstanceIdNumError Get vpcCloudInstanceId number error.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.