DescribeDBInstances
Retorna informações sobre instâncias do Amazon DocumentDB provisionadas. Essa API dá suporte à paginação.
Parâmetros da solicitação
Para obter informações sobre os parâmetros comuns a todas as ações, consulte Parâmetros Comuns.
- DBInstanceIdentifier
-
O identificador da instância fornecido pelo usuário. Se esse parâmetro for especificado, somente as informações da instância específica serão retornadas. Esse parâmetro não diferencia maiúsculas de minúsculas.
Restrições:
-
Deve corresponder ao identificador de um
DBInstanceexistente.
Tipo: string
Obrigatório: Não
-
- Filters.Filter.N
-
Um filtro que especifica uma ou mais instâncias a serem descritas.
Filtros com suporte:
-
db-cluster-id– aceita identificadores de cluster e cluster de nomes do recurso da Amazon (ARNs). A lista de resultados inclui somente informações sobre as instâncias associadas aos clusters identificados por esses ARNs. -
db-instance-id: aceita identificadores de instância e ARNs de instâncias. A lista de resultados inclui somente informações sobre as instâncias identificadas 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
MaxRecordsespecificado, 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 de 20, máximo de 100.
Tipo: número inteiro
Obrigatório: Não
Elementos de Resposta
O serviço retorna os seguintes elementos.
- DBInstances.DBInstance.N
-
: informações detalhadas sobre uma ou mais instâncias.
Tipo: matriz de objetos DBInstance
- 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 a todas as ações, consulte Erros comuns.
- DBInstanceNotFound
-
DBInstanceIdentifiernão se refere a uma instância existente.Código de Status HTTP: 404
Consulte Também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
