As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeDBClusters
Retorna informações sobre clusters provisionados Amazon DocumentDB. A operação API oferece suporte à paginação. Para determinados atributos de gerenciamento, como o gerenciamento do ciclo de vida de clusters e instâncias, o Amazon DocumentDB aproveita a tecnologia operacional compartilhada com o Amazon RDS e Amazon Neptune. Use o parâmetro de filtro filterName=engine,Values=docdb
para retornar somente clusters do Amazon DocumentDB.
Parâmetros da solicitação
Para obter informações sobre os parâmetros comuns a todas as ações, consulte Parâmetros comuns.
- DBClusterIdentifier
-
O identificador de cluster fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações do cluster especificado serão retornadas. Esse parâmetro não diferencia maiúsculas de minúsculas.
Restrições:
-
Se fornecido, deve corresponder a um
DBClusterIdentifier
existente.
Tipo: string
Obrigatório: Não
-
- Filters.Filter.N
-
Um filtro que especifica um ou mais clusters a serem descritos.
Filtros suportados:
-
db-cluster-id
– aceita identificadores de cluster e cluster de nomes do recurso da Amazon (ARNs). A lista de resultados incluirá somente informações sobre os clusters identificado por esses ARNs.
Tipo: matriz de objetos Filter
Obrigatório: não
-
- Marker
-
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords
.Tipo: String
Obrigatório: Não
- MaxRecords
-
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor
MaxRecords
especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados.Padrão: 100
Restrições: Mínimo 20, máximo 100.
Tipo: Inteiro
Obrigatório: Não
Elementos de Resposta
Os seguintes elementos são retornados pelo serviço.
- DBClusters.DBCluster.N
-
Uma lista de clusters.
Tipo: matriz de objetos DBCluster
- Marker
-
Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por
MaxRecords
.Tipo: string
Erros
Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.
- DBClusterNotFoundFault
-
DBClusterIdentifier
não se refere a um cluster existente.Código de Status HTTP: 404
Consulte Também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: