Atualize uma configuração de serviço

REMENDO /groups/{groupId}/apps/{appId}/services/{serviceId}/config

tokenAuth

Atualizar uma configuração de fonte de dados ou serviço de terceiros [obsoleto].

parâmetros de caminho

groupId string Obrigatório

Uma ID de projeto/grupo do Atlas.
appId string Obrigatório

O ObjectID do seu aplicativo. A seção de ID de projeto e aplicativo do App Services API mostra como localizar esse valor.
serviceId string Obrigatório

O valor _id exclusivo de um serviço.

aplicação/json

corpo, corpo objeto

clusterName string Obrigatório

O nome do cluster da fonte de dados interna. O nome pode ter no máximo 64 caracteres e deve conter apenas letras, números, sublinhados e hifens ASCII.
readPreference string Obrigatório

O modo de preferência de leitura para solicitações de leitura na fonte de dados.

Os valores são primary, primaryPreferred, secondary, secondaryPreferred ou nearest.
readPreferenceTagSets array[string]

Direcione operações de leitura para nós específicos de um conjunto de réplicas.

Os valores são server1 ou server2.
wireProtocolEnabled booleano Obrigatório

Se verdadeiro, os clientes podem se conectar ao aplicativo pelo protocolo de conexão do MongoDB.

_id string Obrigatório
name string Obrigatório

O valor é mongodb-datafederation.
type string Obrigatório

O valor é datalake.
config objeto Obrigatório
Ocultar atributo de configuração Mostrar atributo de configuração objeto
- dataLakeName string Obrigatório
  
  O nome do serviço usado para referir-se à instância do banco de dados federado neste aplicativo Atlas . O nome pode ter no máximo 64 caracteres e deve conter apenas letras, números, sublinhados e hífens ASCII.

name string

O nome do serviço.
type string

O tipo do serviço.

Os valores são aws, twilio, github, gcm ou http.
incoming_webhooks array[objeto]
Ocultar atributos recebidas_webhooks Mostrar atributos embedded_webhooks objeto
- name string Obrigatório
- function_source string Obrigatório
- respond_result booleano Obrigatório
- opções objeto
  Ocultar atributos de opções Mostrar atributos de opções objeto
  
  segredo string
  
  secretAsQueryParam booleano
Versão inteiro

Respostas

204

Atualizado com sucesso.

PATCH /groups/{groupId}/apps/{appId}/services/{serviceId}/config

curl \
 --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{serviceId}/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"clusterName":"Cluster0","readPreference":"primary","readPreferenceTagSets":["server1"],"wireProtocolEnabled":true}'

Exemplos de solicitação

{
  "clusterName": "Cluster0",
  "readPreference": "primary",
  "readPreferenceTagSets": [
    "server1"
  ],
  "wireProtocolEnabled": true
}

{
  "_id": "string",
  "name": "mongodb-datafederation",
  "type": "datalake",
  "config": {
    "dataLakeName": "string"
  }
}

{
  "name": "string",
  "type": "aws",
  "incoming_webhooks": [
    {
      "name": "string",
      "function_source": "string",
      "respond_result": true,
      "options": {
        "secret": "string",
        "secretAsQueryParam": true
      }
    }
  ],
  "version": 42
}