Página inicial do Docs

/ /

blockstore

Página inicial do Docs

/ /

Administração de backup

blockstore

Página inicial do Docs

Administração de backup

blockstore

Atualizar uma configuração do blockstore

Atualiza a configuração de um blockstore.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

PUT /snapshot/mongoConfigs/{BLOCKSTORE-ID}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
BLOCKSTORE-ID	string	O nome exclusivo que rotula esta configuração de blockstore.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome	Tipo	necessidade	Descrição	Default
pretty	booleano	Opcional	Flag indicating whether the response body is in a prettyprint format.	`false`
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: `status`: HTTP response code `content`: Corpo de resposta esperado	`false`

Parâmetros do corpo da solicitação

Nome	Tipo	Descrição
assignEnabled	booleano	Opcional. Sinalizador que indica se esse blockstore pode receber tarefas de backup.
Credenciais criptografadas	booleano	Opcional. Sinalizador que indica se o nome de usuário e a senha desse blockstore foram criptografados usando a ferramenta de credenciais.
rótulos	array de strings	Opcional. Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais blockstores. A definição dessas tags limita quais tarefas de backup esse blockstore pode processar. Se omitido, este blockstore só poderá processar tarefas de backup para projetos que não usem rótulos para filtrar suas tarefas.
Fator de carga	número	Opcional. Um número inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots deve executar em comparação com outro armazenamento de snapshots. Esta opção é necessária somente se mais de um armazenamento de snapshots estiver em uso. Para saber mais sobre Load Factor, consulte Editar um blockstore existente.
maxCapacityGB	número	Opcional. A capacidade máxima disponível esperada do blockstore para uso no alerta. `maxCapacityGB` não impõe nenhuma limitação ao tamanho do banco de dados de apoio.
OIDC	objeto	Opcional. OIDC authentication settings for this store. The `oidc` object accepts the following fields: `enabled`: boolean. Enables OIDC authentication for this store. `method`: string. Um de `callback`, `azure`, `gcp` ou `k8s`. `tokenUri`: string. The IdP token endpoint. Required when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. Required when `method` is `callback`; optional when `method` is `azure`. `clientSecret`: string. The client secret registered with the IdP. Required when `method` is `callback`. If you edit an existing store and omit this field or submit the redacted value returned by a previous `GET` request, Ops Manager preserves the existing secret. `scope`: Corda. O escopo OAuth2 solicitado do IdP. Usado somente quando `method` é `callback`. `tokenResource`: string. The audience or resource identifier for the workload identity token. Required when `method` is `azure` or `gcp`. This value must match the `audience` configured for this IdP in the target MongoDB deployment's `oidcIdentityProviders` setting. Os métodos `callback`, `azure`, `gcp` e `k8s` não exigem todos os mesmos campos. Os métodos `azure`, `gcp` e `k8s` não exigem `clientSecret`. Quando `oidc.enabled` é `true`, forneça apenas hosts e opções de conexão no campo `uri` do armazenamento. O MongoDB Ops Manager ignora qualquer nome de usuário ou senha incorporado no URI. To switch a store from OIDC to another authentication mechanism, submit `oidc: {enabled: false}` in the request instead of omitting the `oidc` object.
uri	string	Uma lista separada por vírgula de hosts no formato `<hostname:port>` que pode ser utilizado para acessar este blockstore.
ssl	booleano	Opcional. Sinalizador que indica se este blockstore aceita apenas conexões criptografadas usando TLS.
writeConcern	string	Opcional. O write concern usado para este blockstore. Os valores aceitos para esta opção são: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Para saber mais sobre os níveis de reconhecimento de gravação no MongoDB, consulte Write Concern.

Resposta

Nome	Tipo	Descrição
assignEnabled	booleano	Sinalizador que indica se esse blockstore pode receber tarefas de backup.
Credenciais criptografadas	booleano	Sinalizador que indica se o nome de usuário e a senha desse blockstore foram criptografados usando a ferramenta de credenciais.
id	string	O nome exclusivo que rotula este blockstore.
rótulos	array de strings	Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais blockstores.
links	array de objetos	Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.
Fator de carga	número	Um número inteiro positivo, diferente de zero, que expressa a quantidade de trabalho de backup que esse armazenamento de snapshots deve executar em comparação com outro armazenamento de snapshots. Esta opção é necessária somente se mais de um armazenamento de snapshots estiver em uso. Para saber mais sobre Load Factor, consulte Editar um blockstore existente.
maxCapacityGB	número	Opcional. A capacidade máxima disponível esperada do blockstore para uso no alerta. `maxCapacityGB` não impõe nenhuma limitação ao tamanho do banco de dados de apoio.
OIDC	objeto	OIDC authentication settings for this store. The `oidc` object contains the following fields: `enabled`: boolean. Indicates whether OIDC authentication is enabled for this store. `method`: string. Um de `callback`, `azure`, `gcp` ou `k8s`. `tokenUri`: string. The IdP token endpoint. Present only when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. `clientSecret`: string. O Ops Manager redige esse valor na resposta e não retorna o segredo bruto do cliente. `scope`: Corda. O escopo OAuth2 solicitado do IdP. Presente somente quando `method` é `callback`. `tokenResource`: string. O identificador de público ou recurso para o token de identidade da carga de trabalho. Presente apenas quando `method` é `azure` ou `gcp`.
uri	string	Uma lista separada por vírgula de hosts no formato `<hostname:port>` que pode ser utilizado para acessar este blockstore.
ssl	booleano	Sinalizador que indica se este blockstore aceita apenas conexões criptografadas usando TLS.
usadoSize	número	A quantidade de capacidade de backup em MB que os backups existentes consomem.
writeConcern	string	O write concern usado para este blockstore. Os valores aceitos para esta opção são: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Para saber mais sobre os níveis de reconhecimento de gravação no MongoDB, consulte Write Concern.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "labels" : [ "l1", "l2" ],
  "loadFactor" : 2,
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "writeConcern" : "W2"
}'

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "id" : "{BLOCKSTORE-CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}",
    "rel" : "self"
  }],
  "loadFactor" : 2,
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

Voltar

criar

Excluir