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á.
DescribeMultiRegionClusters
Retorna detalhes sobre um ou mais clusters multirregionais.
Sintaxe da Solicitação
{
"MaxResults": number
,
"MultiRegionClusterName": "string
",
"NextToken": "string
",
"ShowClusterDetails": boolean
}
Parâmetros da solicitação
Para obter informações sobre os parâmetros comuns a todas as ações, consulte Parâmetros Comuns.
A solicitação aceita os seguintes dados no JSON formato.
- MaxResults
-
O número máximo de resultados a serem retornados.
Tipo: número inteiro
Obrigatório: não
- MultiRegionClusterName
-
O nome de um cluster multirregional específico a ser descrito.
Tipo: String
Obrigatório: Não
- NextToken
-
Um token para especificar onde iniciar a paginação.
Tipo: String
Obrigatório: Não
- ShowClusterDetails
-
Detalhes sobre o cluster multirregional.
Tipo: booliano
Obrigatório: não
Sintaxe da Resposta
{
"MultiRegionClusters": [
{
"ARN": "string",
"Clusters": [
{
"ARN": "string",
"ClusterName": "string",
"Region": "string",
"Status": "string"
}
],
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"NodeType": "string",
"NumberOfShards": number,
"Status": "string",
"TLSEnabled": boolean
}
],
"NextToken": "string"
}
Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.
Os dados a seguir são retornados em JSON formato pelo serviço.
- MultiRegionClusters
-
Uma lista de clusters multirregionais.
Tipo: matriz de objetos MultiRegionCluster
- NextToken
-
Um token a ser usado para recuperar a próxima página de resultados.
Tipo: string
Erros
Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.
- ClusterNotFoundFault
-
HTTPCódigo de status: 400
- InvalidParameterCombinationException
-
HTTPCódigo de status: 400
- InvalidParameterValueException
-
HTTPCódigo de status: 400
- MultiRegionClusterNotFoundFault
-
O cluster multirregional especificado não existe.
HTTPCódigo de status: 400
Consulte também
Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: