Criar uma fonte de dados ou serviço de terceiros

POSTAR /groups/{groupId}/apps/{appId}/services

tokenAuth

Crie uma fonte de dados ou um 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.

aplicação/json

corpo, corpo objeto

_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

201 aplicação/json

Criado com sucesso.
Um dos seguintes:
objeto ServiceConstructor objeto AtlasFederatedInstanceConstructor objeto ThirdPartyService
Ocultar atributos Mostrar atributos

_id string

O ID exclusivo do cluster.

name string

O nome do serviço.

type string

O tipo do serviço.
Ocultar atributos Mostrar atributos

_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.
Os serviços de terceiros são obsoletos

Consulte Serviços de terceiros para obter mais informações.

Ocultar atributos Mostrar atributos

_id string

Um ID exclusivo para o serviço de terceiros.

name string

O nome do serviço de terceiros.

type string

O tipo de serviço de terceiros.

Os valores são aws, twilio, github ou gcm.

Versão inteiro
409

Já existe um serviço com o name fornecido.

POST /groups/{groupId}/apps/{appId}/services

curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","type":"string"}'

Exemplos de solicitação

{
  "name": "string",
  "type": "string"
}

{
  "_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
}

Exemplos de resposta (201)

{
  "_id": "string",
  "name": "string",
  "type": "string"
}

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

{
  "_id": "string",
  "name": "string",
  "type": "aws",
  "version": 42
}