Todos os produtos
Search
Central de documentação

ApsaraDB for MongoDB:Integre o ApsaraDB for MongoDB usando SDKs

Última atualização: Jul 02, 2026

Chame uma operação de API com um SDK para consultar instâncias do ApsaraDB for MongoDB em uma região específica.

Consulte a documentação da API

Consulte a Lista de operações por função para encontrar uma operação de API que consulte instâncias em uma região específica. Por exemplo, chame a operação DescribeDBInstances. Consulte o tópico DescribeDBInstances para verificar os parâmetros de solicitação e as permissões necessários.

Crie um usuário RAM e conceda permissões

Identidades

Você pode chamar a operação com uma conta Alibaba Cloud, uma função RAM ou um usuário RAM. Para mais informações, consulte Identidade, credencial e autorização. Neste exemplo, use um usuário RAM para chamar a operação DescribeDBInstances. Faça login no console do RAM, crie um usuário RAM e anote o par AccessKey desse usuário. Para mais informações, consulte Criar um usuário RAM.

Autorização

  1. Acesse a página Users, localize o usuário RAM desejado e clique em Add Permissions na coluna Actions.

  2. Na seção Policies, pesquise a palavra-chave MongoDB e selecione a política a ser anexada.

    Nota

    AliyunMongoDBFullAccess: concede acesso total ao ApsaraDB for MongoDB.

    AliyunMongoDBReadOnlyAccess: concede acesso somente leitura ao ApsaraDB for MongoDB.

    Para obter informações sobre como criar uma política personalizada, consulte Autorização do RAM.

  3. Clique em OK.

Credencial

O sistema gera um AccessKey padrão ao criar um usuário RAM. Você também pode acessar a página de detalhes do usuário RAM, ir até a aba Certification management e clicar em Create AccessKey. Para mais informações, consulte Criar um AccessKey.

Chame a operação DescribeDBInstances

O exemplo a seguir usa o SDK para Java para chamar a operação DescribeDBInstances.

Configure variáveis de ambiente

Configure o par AccessKey nas variáveis de ambiente para evitar codificar credenciais diretamente no código.

Para mais informações, consulte Configurar variáveis de ambiente no Linux, macOS e Windows.

Baixe o código de exemplo

  1. Acesse a página DescribeDBInstances.

  2. Na aba Parameter Configuration, defina o parâmetro necessário.

    • RegionId: ID da região onde consultar as instâncias.

  3. No lado direito, na aba SDK Sample, selecione v2.0 para a versão do SDK e Java para a linguagem. Em seguida, clique em Download Project.

  4. Descompacte o pacote de código de exemplo no computador e acesse o diretório alibabacloud_sample.

Abra e execute o projeto

Use o IntelliJ IDEA para carregar o projeto. Após carregar as dependências, abra o arquivo src/main/java/com/aliyun/sample/Sample.java e adicione código para imprimir os valores retornados conforme os comentários no próprio código.

Clique no botão Run no canto superior direito da IDE para visualizar o log de saída. O exemplo a seguir mostra uma resposta de amostra:

{
  "headers": {
    "access-control-allow-origin": "*",
    "date": "Wed, 26 Jul 2023 05:45:58 GMT",
    "keep-alive": "timeout=25",
    "transfer-encoding": "chunked",
    "vary": "Accept-Encoding",
    "x-acs-request-id": "CF00C412-4BB5-5D02-803C-46D0AF71DC23",
    "connection": "keep-alive",
    "content-type": "application/json;charset=utf-8",
    "access-control-expose-headers": "*",
    "x-acs-trace-id": "48df4a01d258338ee5327a6a48628426"
  },
  "statusCode": 200,
  "body": {
    "DBInstances": {
      "DBInstance": [
        {
          "capacityUnit": "",
          "chargeType": "PostPaid",
          "creationTime": "2023-07-25T06:32:25Z",
          "DBInstanceClass": "mdb.shard.2x.xlarge.d",
          "DBInstanceId": "dds-***",
          "DBInstanceStatus": "Running",
          "DBInstanceStorage": 500,
          "DBInstanceType": "replicate",
          "engine": "MongoDB",
          "engineVersion": "5.0",
          "expireTime": "2999-09-08T16:00Z",
          "kindCode": "18",
          "lockMode": "Unlock",
          "mongosList": { "mongosAttribute": [] },
          "networkType": "VPC",
          "regionId": "cn-shanghai",
          "replicationFactor": "3",
          "resourceGroupId": "rg-***",
          "shardList": { "shardAttribute": [] },
          "storageType": "cloud_essd1",
          "tags": { "tag": [] },
          "zoneId": "cn-shanghai-m"
        }
      ]
    },
    "pageNumber": 1,
    "pageSize": 30,
    "requestId": "CF00C412-4BB5-5D02-803C-***",
    "totalCount": 3
  }
}