Cluster - Amazon DocumentDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

Cluster

返回有关特定静态集群的信息。

内容

注意

下表中首先描述了必需参数。

adminUserName

弹性集群管理员的名称。

类型:字符串

必需:是

authType

弹性集群的身份验证类型。

类型:字符串

有效值:PLAIN_TEXT | SECRET_ARN

必需:是

clusterArn

弹性集群的 ARN 标识符。

类型:字符串

必需:是

clusterEndpoint

用于连接到弹性集群的 URL。

类型:字符串

必需:是

clusterName

弹性集群的名称。

类型:字符串

必需:是

createTime

创建弹性集群的时间,采用通用协调时间 (UTC)。

类型:字符串

必需:是

kmsKeyId

用于弹性集群加密的 KMS 密钥标识符。

类型:字符串

必需:是

preferredMaintenanceWindow

可进行系统维护的每周时间范围(采用通用协调时间(UTC))。

Format: ddd:hh24:mi-ddd:hh24:mi

类型:字符串

必需:是

shardCapacity

分配给每个弹性集群分片的 vCPU 数目。最大值为 64。允许值为 2、4、8、16、32、64。

类型:整数

必需:是

shardCount

分配给弹性集群的分片数目。最大值为 32。

类型:整数

必需:是

status

弹性集群的状态。

类型:字符串

有效值:CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED

必需:是

subnetIds

弹性集群的 Amazon EC2 子网 ID。

类型:字符串数组

必需:是

vpcSecurityGroupIds

与此集群关联的 EC2 VPC 安全组的列表。

类型:字符串数组

必需:是

backupRetentionPeriod

保留自动快照的天数。

类型:整数

必需:否

preferredBackupWindow

如果启用了自动备份,则创建自动备份的每日时间范围,由确定backupRetentionPeriod

类型:字符串

必需:否

shardInstanceCount

应用于集群中所有分片的副本实例数量。shardInstanceCount值为 1 表示只有一个写入器实例,而任何其他实例都是可用于读取和提高可用性的副本。

类型:整数

必需:否

shards

集群中的分片总数。

类型:Shard 对象数组

必需:否

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: