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á.
DescribeGlobalClusters
Retorna informações sobre os clusters globais do Amazon DocumentDB. Essa API dá suporte à paginação.
nota
Essa ação se aplica somente aos 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.
- Filters.Filter.N
-
Um filtro que especifica um ou mais clusters de banco de dados global a serem descritos.
Filtros compatíveis:
db-cluster-id
aceita identificadores e nome do recurso da Amazon (ARN) de cluster A lista de resultados incluirá somente informações sobre os clusters identificado por esses ARNs.Tipo: matriz de objetos Filter
Obrigatório: não
- GlobalClusterIdentifier
-
O identificador de cluster fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações do cluster especificado serão retornadas. Este parâmetro não diferencia maiúsculas de minúsculas.
Tipo: sequência
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 255.
Padrão:
[A-Za-z][0-9A-Za-z-:._]*
Obrigatório: não
- Marker
-
Um token de paginação opcional fornecido por uma solicitação
DescribeGlobalClusters
anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado porMaxRecords
.Tipo: String
Obrigatório: Não
- MaxRecords
-
O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor
MaxRecords
especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.Tipo: inteiro
Obrigatório: Não
Elementos de Resposta
Os seguintes elementos são retornados pelo serviço.
- GlobalClusters. GlobalClusterMemberN.
-
Tipo: matriz de objetos GlobalCluster
- Marker
-
Tipo: sequência
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- GlobalClusterNotFoundFault
-
GlobalClusterIdentifier
não se refere a um cluster global 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: