Java SDK を使用した特定リージョンのインスタンスリストの照会 - ApsaraDB for MongoDB

SDK を使用して API オペレーションを呼び出し、特定のリージョンの ApsaraDB for MongoDB インスタンスを照会します。

API ドキュメントの確認

機能別のオペレーション一覧を参照して、特定のリージョンのインスタンスを照会する API オペレーションを見つけます。たとえば、DescribeDBInstances API を呼び出すことができます。必要なリクエストパラメーターと権限については、DescribeDBInstances のトピックをご参照ください。

RAM ユーザーの作成と権限の付与

アイデンティティ

Alibaba Cloud アカウント、RAM ロール、または RAM ユーザーを使用してオペレーションを呼び出すことができます。詳細については、「アイデンティティ、認証情報、および認可」をご参照ください。この例では、RAM ユーザー を使用して DescribeDBInstances API を呼び出します。RAM コンソールにログインし、RAM ユーザーを作成して、その AccessKey ペアを記録します。詳細については、「RAM ユーザーの作成」をご参照ください。

認可

ユーザーページに移動し、対象の RAM ユーザーを見つけ、Actions 列の 権限の追加 をクリックします。
ポリシー セクションで、キーワード MongoDB を検索し、アタッチするポリシーを選択します。

説明
AliyunMongoDBFullAccess：ApsaraDB for MongoDB へのフルアクセスを提供します。

AliyunMongoDBReadOnlyAccess：ApsaraDB for MongoDB への読み取り専用アクセスを提供します。

カスタムポリシーの作成方法については、「RAM 認可」をご参照ください。
[OK] をクリックします。

認証情報

RAM ユーザーを作成すると、デフォルトの AccessKey が生成されます。また、RAM ユーザーの詳細ページに移動し、認証管理 タブで AccessKeyの作成 をクリックすることもできます。詳細については、「AccessKey の作成」をご参照ください。

DescribeDBInstances API の呼び出し

次の例では、SDK for Java を使用して DescribeDBInstances API を呼び出します。

環境変数の設定

コード内に認証情報をハードコーディングしないように、環境変数に AccessKey ペアを設定します。

詳細については、「Linux、macOS、および Windows での環境変数の設定」をご参照ください。

サンプルコードのダウンロード

DescribeDBInstances ページに移動します。
Parameter Configuration タブで、必要なパラメーターを設定します。
- RegionId：インスタンスを照会するリージョンの ID
右側の [SDK サンプル] タブで、SDK バージョンに v2.0、言語に Java を選択し、[プロジェクトのダウンロード] をクリックします。
コンピューター上でサンプルコードパッケージを解凍し、alibabacloud_sample ディレクトリにアクセスします。

プロジェクトのオープンと実行

IntelliJ IDEA を使用してプロジェクトを読み込みます。依存関係が読み込まれた後、src/main/java/com/aliyun/sample/Sample.java ファイルを開き、コード内のコメントに基づいて戻り値を出力するコードを追加します。

IDE の右上隅にある実行ボタンをクリックすると、出力ログが表示されます。以下にレスポンスの例を示します：

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