Integración de ApsaraDB for MongoDB mediante SDKs - ApsaraDB for MongoDB

Consulte las instancias de ApsaraDB for MongoDB en una región específica al invocar una operación de API mediante un SDK.

Consulta de la documentación de la API

Revise List of operations by function para localizar una operación de API que permita consultar instancias en una región específica, como DescribeDBInstances. Consulte el tema DescribeDBInstances para conocer los parámetros de solicitud y los permisos obligatorios.

Creación de un usuario de RAM y asignación de permisos

Identidades

Puede invocar la operación con una cuenta de Alibaba Cloud, un rol de RAM o un usuario de RAM. Para obtener más información, consulte Identity, credential, and authorization. En este ejemplo se utiliza un usuario de RAM para invocar la operación DescribeDBInstances. Inicie sesión en la consola de RAM, cree un usuario de RAM y registre el par de AccessKey. Para obtener más información, consulte Create a RAM user.

Autorización

Vaya a la página Users, busque el usuario de RAM deseado y haga clic en Add Permissions en la columna Actions.
En la sección Policies, busque la palabra clave MongoDB y seleccione la directiva que desea adjuntar.

Nota
AliyunMongoDBFullAccess: otorga acceso completo a ApsaraDB for MongoDB.

AliyunMongoDBReadOnlyAccess: otorga acceso de solo lectura a ApsaraDB for MongoDB.

Para obtener información sobre cómo crear una directiva personalizada, consulte RAM authorization.
Haga clic en OK.

Credencial

Al crear un usuario de RAM se genera un AccessKey predeterminado. Si necesita crear un AccessKey adicional, vaya a la página de detalles del usuario de RAM, diríjase a la pestaña Certification management y haga clic en Create AccessKey. Para obtener más información, consulte Create an AccessKey.

Invocación de la operación DescribeDBInstances

A continuación se muestra un ejemplo que utiliza el SDK para Java con el fin de invocar la operación DescribeDBInstances.

Configuración de variables de entorno

Almacene el par de AccessKey en variables de entorno para evitar codificar las credenciales directamente en el código.

Para obtener más información, consulte Configure environment variables in Linux, macOS, and Windows.

Descarga del código de ejemplo

Vaya a la página DescribeDBInstances.
En la pestaña Parameter Configuration, configure el parámetro obligatorio.
- RegionId: identificador de la región donde desea consultar las instancias.
En el lado derecho, en la pestaña SDK Sample, seleccione v2.0 como versión del SDK y Java como lenguaje. Luego, haga clic en Download Project.
Descomprima el paquete con el código de ejemplo en su computadora y abra el directorio alibabacloud_sample.

Apertura y ejecución del proyecto

Cargue el proyecto en IntelliJ IDEA. Una vez resueltas las dependencias, abra el archivo src/main/java/com/aliyun/sample/Sample.java y agregue el código necesario para imprimir los valores devueltos según los comentarios del código.

Haga clic en el botón Run, ubicado en la esquina superior derecha del IDE, para consultar el registro de salida. A continuación se muestra un ejemplo de respuesta:

{
  "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
  }
}