サービス構成の更新

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

tokenAuth

データソースまたはサードパーティサービス [非推奨] の構成を更新します。

path パラメータ

グループ ID string 必須

Atlas Project/Group ID。
appId string 必須

アプリケーションの ObjectID。App Services API プロジェクトとアプリケーション ID のセクションでは、この値を見つける方法が示されています。
serviceId string 必須

サービスのユニークな _id 値。

application/ JSON

body オブジェクト

clusterName string 必須

データソース内のクラスター名。名前の長さは最大 64 文字で、ASCII 文字、数字、アンダースコア、ハイフンのみを含めることができます。
readPreference string 必須

データソースへの読み取りリクエストを行うための読み込み設定（read preference）モード

値は、primary、primaryPreferred、secondary、secondaryPreferred、または nearest です。
readPreferenceTagSets array[string]

読み取り操作のターゲットをレプリカセットの特定のノードに設定します。

値は server1 または server2 です。
wireProtocolEnabled ブール値必須

true の場合、クライアントはMongoDBワイヤプロトコルを介してアプリに接続できます [非推奨] 。

_id string 必須
name string 必須

値は mongodb-datafederation です。
タイプ string 必須

値は datalake です。
config オブジェクト必須
設定属性を非表示コンフィギュレーション属性を表示オブジェクト
- dataLakeName string 必須
  
  この Atlasアプリ内のフェデレーティッドデータベースインスタンスを参照するために使用されるサービス名。名前の長さは最大で 64 文字で、ASCII 文字、数字、アンダースコア、ハイフンのみを含めることができます。

name string

サービス名
タイプ string

サービスの種類

値は、aws、twilio、github、gcm、または http です。
incoming_webhooks array[オブジェクト]
incoming_webhooks 属性を非表示にする incoming_webhooks 属性の表示オブジェクト
- name string 必須
- function_source string 必須
- respond_result ブール値必須
- options オブジェクト
  オプション属性を非表示にするオプション属性の表示オブジェクト
  
  秘密 string
  
  secretAsQueryParameterm ブール値
バージョン integer

応答

204

正常に更新されました。

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}'

リクエスト例

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