GetCluster - Amazon DocumentDB

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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 SDK 中使用此 API 的更多信息,请参阅以下内容: