Recupere detalhes de um cluster em um projeto.
Funções obrigatórias
Você pode chamar esse endpoint com sucesso com qualquer função atribuÃda.
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | Identificador único do projeto. |
| string | Identificador único do cluster que você deseja recuperar. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Parâmetros de resposta
Nome | Tipo | Descrição |
|---|---|---|
| string | Nome de exibição do cluster. Observe que o |
| string | Identificador único do projeto ao qual o cluster pertence. |
| string | Identificador único do cluster. |
| data | Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o MongoDB Ops Manager processou mais recentemente um ping deste cluster. |
| string | Nome do nome do conjunto. O Ops Manager retorna esse valor quando um cluster tem |
| string | Nome do shard. O Ops Manager retorna esse valor quando um cluster tem |
| string | Tipo de cluster. Ops Manager pode retornar:
|
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?pretty=true"Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "clusterName": "myRS", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e8ba20e87d9396ca9b96bd0", "lastHeartbeat": "2020-06-10T14:51:28Z", "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", "rel": "self" } ], "replicaSetName": "myRS", "typeName": "REPLICA_SET"}