Recupere detalhes de todos os clusters 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}/clustersParâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | Identificador único do projeto. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pageNum | número | Opcional | Um inteiro baseado que retorna uma subseção de resultados. |
|
itemsPerPage | número | Opcional | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita. |
|
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não 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, configure Para endpoints que retornam uma lista de resultados, o objeto |
|
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
documento de resposta
O documento JSON de resposta inclui uma array de objetos de result, uma array de objetos de link e uma contagem do número total de objetos de result recuperados.
Nome | Tipo | Descrição |
|---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web. |
| número | Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado. |
results documento incorporado
Cada resultado é um cluster.
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?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
{ "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "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" }, { "clusterName": "cm-clstr-repl", "groupId": "5e84b94c003f2d6370004f4e", "id": "5e84e393395ec72bfc888f6c", "lastHeartbeat": "2020-06-10T15:20:08Z", "links": [ { "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c", "rel": "self" } ], "replicaSetName": "cm-clstr-repl", "typeName": "REPLICA_SET" } ], "totalCount": 2}