GetCluster - Amazon DocumentDB
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

GetCluster

特定のエラスティッククラスターに関する情報を返します。

リクエストの構文

GET /cluster/clusterArn HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

clusterArn

エラスティッククラスターの ARN 識別子。

必須: はい

リクエストボディ

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

cluster

特定のエラスティッククラスターに関する情報を返します。

型: Cluster オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

AccessDeniedException

アクションを実行するための十分なアクセス許可がない場合に発生する例外。

HTTP ステータスコード: 403

InternalServerException

内部サーバーエラーが発生しました。

HTTP ステータスコード: 500

ResourceNotFoundException

指定されたリソースが見つかりませんでした。

HTTP ステータスコード: 404

ThrottlingException

ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。

HTTP ステータスコード: 429

ValidationException

検証例外の定義がある構造。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。