앱 구성 파일 가져오기
현재 앱 구성을 다운로드합니다. 두 가지 형식으로 다운로드하도록 선택할 수 있습니다.
구성 파일 디렉토리가 포함된 압축된 zip 파일입니다. 이는 CLI, 버전 제어 시스템 또는 파일 시스템 기반의 다른 환경으로 작업할 때 가장 유용합니다.
전체 구성을 포함하는 단일 JSON 객체입니다. 이는 API 또는 JSON을 구문 분석할 수 있는 다른 환경으로 작업할 때 가장 유용합니다.
Accept
헤더를 설정하여 다운로드할 형식을 지정합니다.
경로 매개변수
-
Atlas 프로젝트/그룹 ID입니다.
-
애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다.
응답
-
가져오기 성공
응답 속성 숨기기 응답 속성 표시 객체
-
앱의 이름입니다.
provider_region
문자열 필수 사항 다음 중 하나입니다. 값은
aws-us-east-1
,aws-us-west-2
,aws-us-east-2
,aws-eu-central-1
,aws-eu-west-1
,aws-eu-west-2
,aws-ap-southeast-1
,aws-ap-southeast-2
,aws-ap-south-1
또는aws-sa-east-1
입니다.값은
azure-eastus2
,azure-westus
,azure-westeurope
,azure-eastasia
또는azure-southeastasia
입니다.값은
gcp-us-central1
,gcp-us-east4
,gcp-us-west1
,gcp-europe-west1
또는gcp-asia-south1
입니다.-
애플리케이션 배포 모델입니다.
값은
GLOBAL
또는LOCAL
입니다. -
애플리케이션의 환경입니다.
값은
development
,testing
,qa
또는production
입니다. -
다음 중 하나: 속성 숨기기 속성 표시
-
인증 제공자 의 이름입니다. 이메일/비밀번호 인증 의 경우 이 값은 항상
local-userpass
입니다.값은
local-userpass
입니다. -
인증 제공자 의 이름입니다. 이메일/비밀번호 인증 의 경우 이 값은 항상
local-userpass
입니다.값은
local-userpass
입니다. -
true
인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다. config
객체 다음 중 하나입니다. 속성 숨기기 속성 표시
-
true
인 경우 추가 확인 없이 새 사용자 계정을 자동으로 확인합니다.값은
true
입니다. -
내장 비밀번호 재설정 절차의 일부로 사용자에게 전송되는 이메일 에 포함된 URL . 또한 고유한 이메일 재설정
token
및tokenId
를 쿼리 매개변수로 추가합니다.이 URL 비밀번호 재설정 토큰을 Realm SDK의
resetPassword
함수에 전달하여 사용자 확인을 처리하다 해야 합니다. -
내장 비밀번호 재설정 절차의 일부로 사용자에게 전송되는 이메일 의 제목 줄입니다.
속성 숨기기 속성 표시
-
true
인 경우 추가 확인 없이 새 사용자 계정을 자동으로 확인합니다. 내장 이메일 계정 확인의 경우 이 값을false
로 설정하다 .값은
false
입니다. -
내장 확인 흐름의 일부로 새 사용자에게 전송되는 이메일 에 포함된 URL . 또한 이메일 고유한 확인
token
및tokenId
를 쿼리 매개변수로 추가합니다.이 URL은 확인 토큰을 Realm SDK의
confirmUser
함수 또는 관리자 API 보류 중인 이메일/비밀번호 사용자 확인 엔드포인트에 전달하여 사용자 확인을 처리해야 합니다. -
내장 확인 흐름의 일부로 새 사용자에게 전송되는 이메일 의 제목 줄입니다.
-
내장 비밀번호 재설정 절차의 일부로 사용자에게 전송되는 이메일 에 포함된 URL . 또한 고유한 이메일 재설정
token
및tokenId
를 쿼리 매개변수로 추가합니다.이 URL 비밀번호 재설정 토큰을 Realm SDK의
resetPassword
함수에 전달하여 사용자 확인을 처리하다 해야 합니다. -
내장 비밀번호 재설정 절차의 일부로 사용자에게 전송되는 이메일 의 제목 줄입니다.
속성 숨기기 속성 표시
-
true
인 경우 추가 확인 없이 새 사용자 계정을 자동으로 확인합니다. 내장 이메일 계정 확인의 경우 이 값을false
로 설정하다 .값은
false
입니다. -
내장 확인 흐름의 일부로 새 사용자에게 전송되는 이메일 에 포함된 URL . 또한 이메일 고유한 확인
token
및tokenId
를 쿼리 매개변수로 추가합니다.이 URL은 확인 토큰을 Realm SDK의
confirmUser
함수 또는 관리자 API 보류 중인 이메일/비밀번호 사용자 확인 엔드포인트에 전달하여 사용자 확인을 처리해야 합니다. -
내장 확인 흐름의 일부로 새 사용자에게 전송되는 이메일 의 제목 줄입니다.
-
true
인 경우 비밀번호 재설정 프로세스 처리하다 위해 정의한 사용자 지정 함수를 사용합니다.값은
true
입니다. -
비밀번호 재설정 프로세스 처리하는 사용자 지정 함수의 이름입니다.
속성 숨기기 속성 표시
-
true
인 경우 추가 확인 없이 새 사용자 계정을 자동으로 확인합니다. 사용자 지정 함수 계정을 확인하려면 이 값을false
로 설정하다 .값은
false
입니다. -
true
인 경우, 새 이메일 /비밀번호 사용자 계정 등록은 확인 프로세스 처리하다 위해 정의한 사용자 지정 함수를 사용합니다. -
확인 프로세스 처리하는 사용자 지정 함수의 이름입니다.
-
내장 비밀번호 재설정 절차의 일부로 사용자에게 전송되는 이메일 에 포함된 URL . 또한 고유한 이메일 재설정
token
및tokenId
를 쿼리 매개변수로 추가합니다.이 URL 비밀번호 재설정 토큰을 Realm SDK의
resetPassword
함수에 전달하여 사용자 확인을 처리하다 해야 합니다. -
내장 비밀번호 재설정 절차의 일부로 사용자에게 전송되는 이메일 의 제목 줄입니다.
속성 숨기기 속성 표시
-
true
인 경우 추가 확인 없이 새 사용자 계정을 자동으로 확인합니다. 사용자 지정 함수 계정을 확인하려면 이 값을false
로 설정하다 .값은
false
입니다. -
true
인 경우, 새 이메일 /비밀번호 사용자 계정 등록은 확인 프로세스 처리하다 위해 정의한 사용자 지정 함수를 사용합니다. -
확인 프로세스 처리하는 사용자 지정 함수의 이름입니다.
-
true
인 경우 비밀번호 재설정 프로세스 처리하다 위해 정의한 사용자 지정 함수를 사용합니다.값은
true
입니다. -
비밀번호 재설정 프로세스 처리하는 사용자 지정 함수의 이름입니다.
-
속성 숨기기 속성 표시
-
인증 제공자 의 이름입니다. 사용자 지정 JSON web token 인증 의 경우 이 값은 항상
custom-token
입니다.값은
custom-token
입니다. -
인증 제공자 의 이름입니다. 사용자 지정 JSON web token 인증 의 경우 이 값은 항상
custom-token
입니다.값은
custom-token
입니다. -
true
인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다. -
사용자 지정 JSON web token 인증 제공자 대한 구성 객체 .
구성 속성 숨기기 구성 속성 표시 객체
-
외부 JSON web token 에서
aud
클레임의 예상 값을 정의합니다. 기본값 으로 사용자 지정 JSON web token 제공자aud
을 앱 ID 로 예상합니다. -
인 경우
false
외부 JSON web token 클레임의 에 정의된 모든 값을 포함해야 합니다.audience
aud
인
true
경우, 에 정의된 값 중 하나라도 해당 클레임에audience
있는aud
경우 JSON web token 유효합니다.기본값은
false
입니다. -
외부 시스템이 JSON web token 에 서명하는 데 사용하는 암호화 방법입니다. 사용자 지정 JSON web token 인증 다음 알고리즘 중 하나를 사용하여 서명된 JWT를 지원합니다.
- HS256
- RS256
-
true
인 경우 사용자 지정 JSON web token 제공자 JSON 웹 키 (JWK) 또는 JSON 웹 키 세트(JWKS)에 정의된 서명 알고리즘 및 서명 키를 사용합니다. JWK(S)는jwkURI
에 지정된 URL 에서 액세스할 수 있어야 합니다. -
사용자 지정 JSON web token 제공자 사용해야 하는 서명 방법 및 서명 키를 설명하는 JWK 또는 JWKS를 호스팅하는 URL 입니다. JWK(S)는 최대 3개의 서명 키를 지정할 수 있으며 RS256 알고리즘 사용해야 합니다.
-
-
메타데이터 필드는 각 사용자를 설명하는 추가 데이터입니다. 각 메타데이터 필드 의 값은 외부 인증 시스템의 JSON web token 에 포함된 일부 필드 에서 가져옵니다.
사용자의 메타데이터 필드는 로그인 때마다 새로 고쳐집니다.
사용자 데이터를 포함하기 위한 외부 JSON web token 의 특정 메타데이터 필드 . 이렇게 하면 외부 JSON web token 필드 이름(
name
)이 해당 필드 값을 보유하는 사용자 데이터의 필드 이름(field_name
)에 매핑됩니다.metadata_fields 속성 숨기기 metadata_fields 속성 표시 객체
-
true
인 경우 이 값은 항상 외부 JSON web token 에 있어야 합니다. -
데이터가 포함된 외부 JSON web token 의 필드 이름입니다.
내장된 객체에서 필드를 지정하려면 점 표기법을 사용합니다.
-
값을 보유하는 사용자 객체 의 필드 이름입니다.
-
속성 숨기기 속성 표시
-
인증 제공자 의 이름입니다. 사용자 지정 함수 인증 의 경우 이 값은 항상
custom-function
입니다.값은
custom-function
입니다. -
인증 제공자 의 이름입니다. 사용자 지정 함수 인증 의 경우 이 값은 항상
custom-function
입니다.값은
custom-function
입니다. -
true
인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다. -
사용자 지정 함수 인증 제공자 에 대한 구성 객체 .
구성 속성 숨기기 구성 속성 표시 객체
-
사용자 로그인을 처리하는 사용자 지정 인증 함수 의 이름입니다.
-
속성 숨기기 속성 표시
-
인증 제공자 의 이름입니다. Apple 인증 의 경우 이 값은 항상
oauth2-apple
입니다.값은
oauth2-apple
입니다. -
인증 제공자 의 이름입니다. Apple 인증 의 경우 이 값은 항상
oauth2-apple
입니다.값은
oauth2-apple
입니다. -
true
인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다. -
Apple 인증 제공자 대한 구성 객체 .
구성 속성 숨기기 구성 속성 표시 객체
-
Apple 서비스 ID.
이를 가져오는 방법을 학습 서비스 ID 만들기를 참조하세요.
-
-
secret_config 속성 숨기기 secret_config 속성 표시 객체
-
클라이언트 시크릿 JSON web token 보관하는 시크릿의 이름입니다.
이를 생성하는 방법을 학습하려면 클라이언트 시크릿 JSON web token 생성을 참조하세요.
-
-
OAuth 흐름에서 사용자가 리디렉션을 허용해야 하는 URI 목록입니다.
속성 숨기기 속성 표시
-
인증 제공자 의 이름입니다. Google 인증 의 경우 이 값은 항상
oauth2-google
입니다.값은
oauth2-google
입니다. -
인증 제공자 의 이름입니다. Google 인증 의 경우 이 값은 항상
oauth2-google
입니다.값은
oauth2-google
입니다. -
true
인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다. -
Google 인증 제공자 대한 구성 객체 .
구성 속성 숨기기 구성 속성 표시 객체
-
OAuth 2.0 GCP 프로젝트 의 클라이언트 ID .
프로젝트를 만드는 방법을 학습하려면 Google API 콘솔에서 프로젝트 설정하기를 참조하세요.
-
An OAuth 2.0
-
-
secret_config 속성 숨기기 secret_config 속성 표시 객체
-
OAuth 2.0 을 보유하는 시크릿의 이름입니다.
config.clientId
에 지정된 클라이언트 ID 에 대한 클라이언트 시크릿입니다.
-
-
OAuth 흐름에서 사용자가 리디렉션을 허용해야 하는 URI 목록입니다.
-
메타데이터 필드는 각 사용자를 설명하는 추가 데이터입니다. 각 메타데이터 필드 의 값은 Google에서 제공하며 인증된 JSON web token 에 포함되어 있습니다.
사용자의 메타데이터 필드는 로그인 때마다 새로 고쳐집니다.
-
사용자 계정에 대해 승인된 도메인 이름 목록입니다. 이 항목이 정의된 경우 사용자는 이 목록에 도메인이 포함된 OAuth 프로필과 연결된 이메일 주소 있어야 합니다.
속성 숨기기 속성 표시
-
인증 제공자 의 이름입니다. Facebook 인증 의 경우 이 값은 항상
oauth2-facebook
입니다.값은
oauth2-facebook
입니다. -
인증 제공자 의 이름입니다. Facebook 인증 의 경우 이 값은 항상
oauth2-facebook
입니다.값은
oauth2-facebook
입니다. -
true
인 경우 인증 제공자가 비활성화됩니다. 활성화될 때까지 사용자는 제공자를 통해 로그인할 수 없습니다. -
Facebook 인증 제공자 대한 구성 객체 .
-
secret_config 속성 숨기기 secret_config 속성 표시 객체
-
Facebook 앱 시크릿 을 보관하는 시크릿의 이름입니다.
-
-
OAuth 흐름에서 사용자가 리디렉션을 허용해야 하는 URI 목록입니다.
-
메타데이터 필드는 각 사용자를 설명하는 추가 데이터입니다. 각 메타데이터 필드 의 값은 Facebook 에서 가져오며 인증된 JSON web token 에 포함됩니다.
사용자의 메타데이터 필드는 로그인 때마다 새로 고쳐집니다.
-
사용자 계정에 대해 승인된 도메인 이름 목록입니다. 이 항목이 정의된 경우 사용자는 이 목록에 도메인이 포함된 OAuth 프로필과 연결된 이메일 주소 있어야 합니다.
-
-
custom_user_data 속성 숨기기 custom_user_data 속성 표시 객체 | null
-
사용자 지정 사용자 데이터가 포함된 데이터베이스의 이름입니다.
-
사용자 지정 사용자 데이터가 포함된 컬렉션의 이름입니다.
-
모든 사용자 지정 사용자 데이터 문서에 표시되고 각 문서에 해당하는 사용자의 사용자 계정 ID를 포함하는 필드의 이름입니다.
-
true
인 경우 사용자 지정 사용자 데이터가 활성화됩니다. -
사용자 지정 사용자 데이터 포함된 연결된 MongoDB 데이터 소스 의 이름입니다.
-
새 사용자가 등록할 때마다 실행되는 사용자 생성 함수 의 이름입니다.
-
-
data_api_config 속성 숨기기 data_api_config 속성 표시 객체 | null
-
데이터 API 의 지원되는 버전입니다.
값은
v1
입니다. -
데이터 API 및 사용자 지정 엔드포인트에서 지원하는 데이터 형식입니다.
값은
JSON
또는EJSON
입니다. -
애플리케이션 사용자의 계정 ID. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다.
-
애플리케이션 사용자의 계정 ID를 반환하는 함수에 대한 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다.
-
값은
NO_VALIDATION
,SECRET_AS_QUERY_PARAM
또는VERIFY_PAYLOAD
입니다. -
validation_method
가"SECRET_AS_QUERY_PARAM"
또는"VERIFY_PAYLOAD"
로 설정된 경우 요청을 승인하는 시크릿의name
니다. -
수신 요청에 대한 응답으로 엔드포인트의 실행이 허용되는 경우
true
로 평가되는 JSON 표현식입니다.
-
다음 중 하나입니다. 속성 숨기기 속성 표시
-
서비스 이름입니다.
-
서비스 유형입니다.
-
구성 속성 숨기기 구성 속성 표시 객체
-
내부 데이터 소스의 클러스터 이름입니다. 이름은 최대 64자 이하여야 하며, ASCII 문자, 숫자, 밑줄 및 하이픈만 포함할 수 있습니다.
-
데이터 소스에 대한 읽기 요청의 읽기 설정 모드입니다.
값은
primary
,primaryPreferred
,secondary
,secondaryPreferred
또는nearest
입니다. -
복제본 세트의 특정 노드를 대상으로 읽기 작업을 수행합니다.
값은
server1
또는server2
입니다. -
true인 경우 클라이언트는 MongoDB 유선 프로토콜[사용 중단됨]을 통해 앱에 연결할 수 있습니다.
-
-
정의하는 데이터 액세스 규칙은 보다 구체적인 권한이 정의되지 않은 컬렉션에 대한 대체 사용자 역할 및 쿼리 필터를 정의합니다.
default_rule 속성 숨기기 default_rule 속성 표시 객체
-
기본 사용자 역할의 정렬된 목록입니다.
역할 속성 숨기기 역할 속성 표시 객체
-
document_filters 속성 숨기기 document_filters 속성 표시 객체
-
역할의 이름입니다.
-
문서 필드 이름을 필드 및 해당 하위 항목에 대한 읽기 및 쓰기 (write) 권한에 매핑하는 객체 입니다.
-
필드 에 대한 읽기 및 쓰기 (write) 권한입니다.
additional_fields 속성 숨기기 additional_fields 속성 표시 객체
-
-
기본 쿼리 필터 목록입니다.
들어오는 쿼리 작업을 실행 전에 조건부로 수정하는 필터하다 입니다.
필터 속성 숨기기 필터 속성 표시 객체
-
필터의 이름입니다.
-
MongoDB 쿼리 객체.
-
MongoDB 프로젝션 객체.
-
-
-
연결된 데이터 소스 의 컬렉션 에 대한 사용자 역할 및 쿼리 필터를 정의하는 데이터 액세스 규칙입니다.
규칙 속성 숨기기 규칙 속성 표시 객체
-
연결된 데이터 소스에 있는 데이터베이스의 이름입니다.
-
지정된
database
에 있는 컬렉션의 이름입니다. -
데이터 액세스 역할 목록입니다.
역할 속성 숨기기 역할 속성 표시 객체
-
document_filters 속성 숨기기 document_filters 속성 표시 객체
-
역할의 이름입니다.
-
문서 필드 이름을 필드 및 해당 하위 항목에 대한 읽기 및 쓰기 (write) 권한에 매핑하는 객체 입니다.
-
필드 에 대한 읽기 및 쓰기 (write) 권한입니다.
additional_fields 속성 숨기기 additional_fields 속성 표시 객체
-
-
수신 작업에 대한 필터 목록입니다.
들어오는 쿼리 작업을 실행 전에 조건부로 수정하는 필터하다 입니다.
필터 속성 숨기기 필터 속성 표시 객체
-
필터의 이름입니다.
-
MongoDB 쿼리 객체.
-
MongoDB 프로젝션 객체.
-
-
-
-
엔드포인트 속성 숨기기 엔드포인트 속성 표시 객체
-
환경 속성 숨기기 환경 속성 표시 객체
-
가능한 각 환경 이름을 해당 환경에서 사용 가능한 환경 값의 정의에 매핑하는 객체 입니다.
-
-
함수 속성 숨기기 함수 속성 표시 객체
-
수신 요청에 대한 응답으로 함수의 실행이 허용되는 경
true
로 평가되는 JSON 표현식입니다. -
함수의 고유 이름입니다.
-
true
인 경우 클라이언트 애플리케이션에서 함수가 숨겨집니다. JSON 표현식 및 수신 웹훅 및 트리거를 포함한 다른 함수에서 비공개 함수를 계속 호출할 수 있습니다. -
함수의 문자열화된 소스 코드입니다. 코드는 유효한 ES6여야 합니다.
-
true
인 경우 함수가 모든 서비스에 대한 규칙을 우회하여 전체 권한으로 실행됩니다. -
애플리케이션 사용자의 계정 ID입니다. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다.
run_as_user_id_script_source
와 함께 사용할 수 없습니다. -
애플리케이션 사용자의 계정 ID 반환하는 함수 의 문자열화된 소스 코드 . 정의된 경우 엔드포인트는 모든 요청 에서 함수를 실행하고 함수에서 반환된 ID 가진 사용자로 실행 .
run_as_user_id
와 함께 사용할 수 없습니다.
-
-
GraphQL 속성 숨기기 GraphQL 속성 표시 객체
-
구성 속성 숨기기 구성 속성 표시 객체
-
true
인 경우 생성된 스키마 유형 이름은 가능할 때마다 일반적인 영어 복수형을 사용합니다.false
인 경우 또는 자연 복수형을 결정할 수 없는 경우 복수 유형은 끝에"s"
가 추가된 단수 유형 이름을 사용합니다.앱을 생성한 후에는 이 값을 변경할 수 없습니다. 모든 새 앱의 경우 이 값은
true
입니다. -
true
인 경우 GraphQL API는 클라이언트의 인트로스펙션 쿼리를 차단합니다.
-
-
custom_resolvers 속성 숨기기 custom_resolvers 속성 표시 객체
-
해석기의 상위 유형 이름입니다.
"Query"
,"Mutation"
또는 계산된 속성인 경우 생성된 유형의 이름일 수 있습니다. -
GraphQL 스키마에 표시되는 사용자 지정 해석기 필드의 이름입니다.
-
사용자 지정 해석기가 사용하는 입력 유형의 종류입니다. 이 값은
input_type
의 값과 일치해야 합니다.- 스칼라 입력 유형은
"scalar"
또는"scalar-list"
를 사용해야 합니다. - 생성된 입력 유형은
"generated"
또는"generated-list"
를 사용해야 합니다. - 사용자 지정 입력 유형은 다음을 사용해야 합니다.
"custom"
정의되지 않은 경우 해석기는 입력을 허용하지 않습니다.
값은
scalar
,scalar-list
,generated
,generated-list
또는custom
입니다. - 스칼라 입력 유형은
-
사용자 지정 해석기가 사용하는 페이로드 유형의 종류입니다. 이 값은
payload_type
의 값과 일치해야 합니다.- 스칼라 페이로드 유형은
"scalar"
또는"scalar-list"
를 사용해야 합니다. - 생성된 페이로드 유형은
"generated"
또는"generated-list"
를 사용해야 합니다. - 사용자 지정 페이로드 유형은 다음을 사용해야 합니다.
"custom"
정의되지 않은 경우 해석기는
DefaultPayload
객체를 반환합니다.값은
scalar
,scalar-list
,generated
,generated-list
또는custom
입니다. - 스칼라 페이로드 유형은
-
리졸버 함수의 이름입니다.
-
-
-
[더 이상 사용되지 않음] 레거시 HTTP 서비스 목록입니다. 이는 이전 버전과의 호환성을 위한 용도로만 사용됩니다.
https_endpoints 속성 숨기기 https_endpoints 속성 표시 객체
-
log_forwarders 속성 숨기기 log_forwarders 속성 표시 객체
-
값은
auth
,endpoint
,function
,graphql
,push
,schema
,service
,sync
,trigger
또는trigger_error_handler
입니다. -
값은
error
또는success
입니다.
-
스키마 속성 숨기기 스키마 속성 표시 객체
-
메타데이터는 스키마가 적용되는 연결된 컬렉션을 설명합니다.
-
컬렉션의 유효한 스키마입니다.
스키마 속성 숨기기 스키마 속성 표시 객체
-
필드의 BSON types 입니다.
값은
object
,array
,string
,number
,int
,long
,double
,decimal
,date
,timestamp
,bool
,null
,regex
,objectId
,binary
,uuid
,function
,javascript
,symbol
,minKey
또는maxKey
. -
사람이 읽을 수 있는 스키마 제목입니다.
-
object
스키마의 경우 객체 인스턴스에 필요한 필드 이름의 배열 . -
각 필드 이름이 스키마 의 속성 객체 입니다. 해당 값은 해당 필드에 대한 스키마 정의입니다.
속성 속성 숨기기 속성 속성 표시 객체
-
컬렉션의 유효한 스키마입니다.
-
-
-
외부 컬렉션과의 관계입니다. 각 필드 이름은 스키마의 속성입니다. 해당 값은 해당 필드에 대한 관계 정의입니다.
관계 속성 숨기기 관계 속성 표시 객체
-
관계 정의입니다.
-
-
-
[더 이상 사용되지 않음] 레거시 타사 비 HTTP 서비스 목록입니다. 이는 이전 버전과의 호환성을 위한 용도로만 사용됩니다.
서비스 속성 숨기기 서비스 속성 표시 객체
-
동기화 속성 숨기기 동기화 속성 표시 객체
-
동기화 서비스의 상태 (
"enabled"
,"disabled"
또는 동기화가 구성되지 않은 경우 비어 있음)입니다. -
App Services가 개발 모드에서 데이터를 저장하는 동기화된 클러스터의 데이터베이스 이름입니다. App Services는 동기화된 각 유형에 대한 스키마를 자동으로 생성하고 각 객체 유형을 데이터베이스 내의 컬렉션에 매핑합니다.
-
컬렉션 에 있는 쿼리 가능 필드 이름의 배열 .
-
인덱싱된 쿼리 가능 필드로 사용할 필드 이름 목록입니다. 이 속성 은 배열 이지만 Sync는 현재 인덱싱된 쿼리 가능 필드 하나만 지원합니다. 따라서 이 배열 최대 하나의 요소만 포함될 수 있습니다.
인덱싱된 쿼리 가능 필드 스키마 에 존재해야 하며 동기화 모든 컬렉션 에서 동일한 적격 필드 유형이어야 합니다. 인덱싱된 쿼리 가능 필드 이름은 글로벌 쿼리 가능 필드 이므로
queryable_fields_names
에도 표시되어야 합니다. -
지정된 컬렉션에 있는 쿼리 가능 필드 이름의 배열.
-
더 이상 사용되지 않습니다.
-
마지막으로 동기화가 비활성화된 시간으로, UNIX 에포크 이후의 시간(초)으로 표시됩니다.
-
클라이언트 재설정 필요하기 전에 클라이언트 오프라인 상태일 수 있는 일수입니다.
-
클라이언트 재설정 모드 비활성화할지 여부를 지정합니다. 기본값 으로 클라이언트 재설정 모드 활성화되어 있으며 이 값은
false
입니다. -
데이터 수집 통해 비대칭으로 정의된 컬렉션 이름의 배열, 클라이언트는 데이터를 쓰기 (write) 수는 있지만 읽을 수는 없습니다.
-
-
다음 중 하나입니다. 속성 숨기기 속성 표시
-
트리거의 이름입니다.
-
트리거 유형입니다. 데이터베이스 트리거의 경우 이 값은 항상
"DATABASE"
입니다.값은
DATABASE
입니다. -
true
인 경우 트리거가 비활성화되고 이벤트를 수신하거나 실행되지 않습니다.기본값은
false
입니다. -
트리거에 대한 구성 값을 정의하는 객체입니다.
구성 속성 숨기기 구성 속성 표시 객체
-
감시된 컬렉션 포함하는 연결된 MongoDB 데이터 소스 의
_id
값입니다.모든 서비스 가져오기 엔드포인트를 사용하여 서비스를 나열할 수 있습니다.
데이터 소스는
type
이 'mongodb-atlas'인 서비스입니다. 트리거하다 에 연결하려는 데이터 소스 에 대해_id
값을 사용합니다. -
연결된 데이터 소스 에 있는 데이터베이스 의 이름입니다. 이 매개변수를 생략하면 소스 유형이 '배포'로 변경됩니다. 그러나 공유 계층 인프라는 배포서버 변경 스트림을 지원 하지 않습니다. ' 데이터베이스' 매개 변수를 생략하면 ' 배포서버 변경 스트림은 공유 계층 클러스터에서 지원되지 않습니다' 오류가 발생합니다. 이 오류를 해결하려면 데이터베이스 매개변수를 제공하세요.
-
지정된 데이터베이스 에 있는 컬렉션 의 이름입니다. 트리거하다 이 컬렉션 에서 이벤트를 수신 대기합니다. 이 매개변수를 생략하면 소스 유형이 '데이터베이스'로 변경됩니다.
-
트리거하다 수신 대기하는 MongoDB 변경 이벤트 의 유형입니다.
모든 트리거에 유효한 작업 유형은 다음과 같습니다.
"INSERT"
"UPDATE"
"REPLACE"
"DELETE"
데이터베이스 및 배포서버 트리거에 유효한 추가 작업 유형은 다음과 같습니다.
"CREATE_COLLECTION"
"MODIFY_COLLECTION"
"RENAME_COLLECTION"
"DROP_COLLECTION"
"SHARD_COLLECTION"
"RESHARD_COLLECTION"
"REFINE_COLLECTION_SHARD_KEY"
배포서버 트리거에 유효한 추가 작업 유형은 다음과 같습니다.
"DROP_DATABASE"
자세한 내용은 트리거하다 구성을 참조하세요.
요소가
1
개 이상이어야 합니다. -
$match 표현식 변경 이벤트를 필터링합니다. 트리거하다 지정된 변경 이벤트 에 대해 표현식 true로 평가되는 경우에만 실행됩니다.
-
$ 프로젝트 표현식 지정된 필드만 반환합니다. 특정 필드를 포함 또는 제외하거나 새로 계산된 필드를 포함할 수 있습니다.
-
기본값은
false
입니다. -
true인 경우
UPDATE
변경 이벤트에 업데이트 적용되기 직전에 수정된 문서 의 스냅샷 포함되어야 함을 나타냅니다.이러한 스냅샷을 포함하려면 클러스터에 대한 문서 사전 이미지를 활성화 해야 합니다.
기본값은
false
입니다. -
true
인 경우, 트리거하다 비활성화한 후 활성화하면 트리거하다 비활성화된 동안 발생한 이벤트가 호출되지 않습니다.기본값은
false
입니다. -
true
인 경우 클러스터의 oplog 에서 이 트리거의 재개 토큰을 찾을 수 없는 경우 트리거하다 다음번 관련 변경 스트림 이벤트 에서 이벤트 처리 자동으로 재개합니다. 트리거하다 일시 중단된 시점부터 트리거하다 다시 실행될 때까지의 모든 변경 스트림 이벤트에는 트리거하다 실행되지 않습니다.기본값은
false
입니다. -
true
인 경우 트리거하다 처리량 최대화 옵션을 사용합니다.기본값은
false
입니다. -
true
인 경우 이벤트 순서 지정이 비활성화되고 이 트리거하다 이벤트를 병렬로 프로세스 할 수 있습니다.false
인 경우 이벤트 순서 지정이 활성화되고 트리거하다 이벤트를 순차적으로 실행합니다.기본값은
false
입니다.
-
-
트리거가 실행될 때 호출하는 함수의 ID입니다.
이 값은
event_processors.FUNCTION.function_id
와 동일합니다. 여기 또는event_processors.FUNCTION.function_id
에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.예를 들어,
function_id
를 정의하면 백엔드는 이를event_processors.FUNCTION.function_id
에 복제합니다.function_id
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_id
또는event_processors
중 하나를 제공해야 합니다. -
트리거가 실행될 때 호출하는 함수의 이름입니다. 즉,
function_id
에서 설명된 함수입니다.이 값은
event_processors.FUNCTION.function_name
와 동일합니다. 여기 또는event_processors.FUNCTION.function_name
에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.예를 들어,
function_name
를 정의하면 백엔드는 이를event_processors.FUNCTION.function_name
에 복제합니다.function_name
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_name
또는event_processors
중 하나를 제공해야 합니다. -
객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요.
event_processors 속성 숨기기 event_processors 속성 표시 객체
-
FUNCTION 속성 숨기기 FUNCTION 속성 표시 객체
-
구성 속성 숨기기 구성 속성 표시 객체
-
트리거가 실행될 때 호출하는 함수의 ID입니다.
이 값은 루트 수준
function_id
와 동일합니다. 여기 또는function_id
에서 값을 정의할 수 있습니다. App Services 백엔드 정의하지 않은 구성 위치 에 값을 복제합니다.예를 들어,
event_processors.FUNCTION.function_id
를 정의하면 백엔드는 이를function_id
에 복제합니다.function_id
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_id
또는event_processors
중 하나를 제공해야 합니다. -
트리거가 실행될 때 호출하는 함수의 이름입니다. 즉,
function_id
에서 설명된 함수입니다.이 값은 루트 수준
function_name
와 동일합니다. 여기 또는function_name
에서 값을 정의할 수 있습니다. App Services 백엔드 정의하지 않은 구성 위치 에 값을 복제합니다.예를 들어,
event_processors.FUNCTION.function_name
를 정의하면 백엔드는 이를function_name
에 복제합니다.function_name
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_name
또는event_processors
중 하나를 제공해야 합니다.
-
-
-
-
AWS EventBridge 트리거에 대한 사용자 지정 오류 처리를 정의하는 객체입니다.
"AWS_EVENTBRIDGE"
이벤트 프로세서가 있는 Atlas Triggers 유형"DATABASE"
에만 유효합니다.
속성 숨기기 속성 표시
-
트리거의 이름입니다.
-
트리거하다 유형입니다. 인증 트리거의 경우 이 값은 항상
"AUTHENTICATION"
입니다.값은
AUTHENTICATION
입니다. -
true
인 경우 트리거가 비활성화되고 이벤트를 수신하거나 실행되지 않습니다.기본값은
false
입니다. -
트리거에 대한 구성 값을 정의하는 객체입니다.
-
트리거가 실행될 때 호출하는 함수의 ID입니다.
이 값은
event_processors.FUNCTION.function_id
와 동일합니다. 여기 또는event_processors.FUNCTION.function_id
에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.예를 들어,
function_id
를 정의하면 백엔드는 이를event_processors.FUNCTION.function_id
에 복제합니다.function_id
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_id
또는event_processors
중 하나를 제공해야 합니다. -
트리거가 실행될 때 호출하는 함수의 이름입니다. 즉,
function_id
에서 설명된 함수입니다.이 값은
event_processors.FUNCTION.function_name
와 동일합니다. 여기 또는event_processors.FUNCTION.function_name
에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.예를 들어,
function_name
를 정의하면 백엔드는 이를event_processors.FUNCTION.function_name
에 복제합니다.function_name
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_name
또는event_processors
중 하나를 제공해야 합니다. -
객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요.
event_processors 속성 숨기기 event_processors 속성 표시 객체
-
FUNCTION 속성 숨기기 FUNCTION 속성 표시 객체
-
구성 속성 숨기기 구성 속성 표시 객체
-
트리거가 실행될 때 호출하는 함수의 ID입니다.
이 값은 루트 수준
function_id
와 동일합니다. 여기 또는function_id
에서 값을 정의할 수 있습니다. App Services 백엔드 정의하지 않은 구성 위치 에 값을 복제합니다.예를 들어,
event_processors.FUNCTION.function_id
를 정의하면 백엔드는 이를function_id
에 복제합니다.function_id
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_id
또는event_processors
중 하나를 제공해야 합니다. -
트리거가 실행될 때 호출하는 함수의 이름입니다. 즉,
function_id
에서 설명된 함수입니다.이 값은 루트 수준
function_name
와 동일합니다. 여기 또는function_name
에서 값을 정의할 수 있습니다. App Services 백엔드 정의하지 않은 구성 위치 에 값을 복제합니다.예를 들어,
event_processors.FUNCTION.function_name
를 정의하면 백엔드는 이를function_name
에 복제합니다.function_name
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_name
또는event_processors
중 하나를 제공해야 합니다.
-
-
-
속성 숨기기 속성 표시
-
트리거의 이름입니다.
-
트리거하다 유형입니다. 예약된 트리거의 경우 이 값은 항상
"SCHEDULED"
입니다.값은
SCHEDULED
입니다. -
true
인 경우 트리거가 비활성화되고 이벤트를 수신하거나 실행되지 않습니다.기본값은
false
입니다. -
트리거에 대한 구성 값을 정의하는 객체입니다.
구성 속성 숨기기 구성 속성 표시 객체
-
트리거 하다 실행되는 시점을 지정하는 크론 표현식 입니다.
-
true
인 경우, 트리거하다 비활성화한 후 활성화하면 트리거하다 비활성화된 동안 발생한 이벤트가 호출되지 않습니다.
-
-
트리거가 실행될 때 호출하는 함수의 ID입니다.
이 값은
event_processors.FUNCTION.function_id
와 동일합니다. 여기 또는event_processors.FUNCTION.function_id
에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.예를 들어,
function_id
를 정의하면 백엔드는 이를event_processors.FUNCTION.function_id
에 복제합니다.function_id
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_id
또는event_processors
중 하나를 제공해야 합니다. -
트리거가 실행될 때 호출하는 함수의 이름입니다. 즉,
function_id
에서 설명된 함수입니다.이 값은
event_processors.FUNCTION.function_name
와 동일합니다. 여기 또는event_processors.FUNCTION.function_name
에 값을 정의할 수 있습니다. App Services 백엔드는 정의하지 않은 구성 위치에 값을 복제합니다.예를 들어,
function_name
를 정의하면 백엔드는 이를event_processors.FUNCTION.function_name
에 복제합니다.function_name
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_name
또는event_processors
중 하나를 제공해야 합니다. -
객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요.
event_processors 속성 숨기기 event_processors 속성 표시 객체
-
FUNCTION 속성 숨기기 FUNCTION 속성 표시 객체
-
구성 속성 숨기기 구성 속성 표시 객체
-
트리거가 실행될 때 호출하는 함수의 ID입니다.
이 값은 루트 수준
function_id
와 동일합니다. 여기 또는function_id
에서 값을 정의할 수 있습니다. App Services 백엔드 정의하지 않은 구성 위치 에 값을 복제합니다.예를 들어,
event_processors.FUNCTION.function_id
를 정의하면 백엔드는 이를function_id
에 복제합니다.function_id
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_id
또는event_processors
중 하나를 제공해야 합니다. -
트리거가 실행될 때 호출하는 함수의 이름입니다. 즉,
function_id
에서 설명된 함수입니다.이 값은 루트 수준
function_name
와 동일합니다. 여기 또는function_name
에서 값을 정의할 수 있습니다. App Services 백엔드 정의하지 않은 구성 위치 에 값을 복제합니다.예를 들어,
event_processors.FUNCTION.function_name
를 정의하면 백엔드는 이를function_name
에 복제합니다.function_name
을(를) 정의하는 경우event_processors
이(가) 필요하지 않습니다. 트리거하다 업데이트할 때function_name
또는event_processors
중 하나를 제공해야 합니다.
-
-
-
-
-
Hide values attributes 값 속성 표시 객체
-
true
인 경우 값은 이름별로 Secret 에 대한 참조입니다.
앱 구성 파일 디렉토리 포함된 zip 파일
-
-
Invalid request
-
구성 가져오기 오류
curl \
--request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/pull' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"name": "string",
"provider_region": "aws-us-east-1",
"deployment_model": "GLOBAL",
"environment": "production",
"auth_providers": [
{
"name": "anon-user",
"type": "anon-user",
"disabled": true
}
],
"custom_user_data": {
"database_name": "myapp",
"collection_name": "users",
"user_id_field": "user_account_id",
"enabled": true,
"mongo_service_name": "mongodb-atlas",
"on_user_creation_function_name": "myFunction"
},
"data_api_config": {
"disabled": true,
"versions": [
"v1"
],
"return_type": "JSON",
"create_user_on_auth": true,
"run_as_user_id": "string",
"run_as_user_id_script_source": "string",
"validation_method": "NO_VALIDATION",
"secret_name": "string",
"can_evaluate": {}
},
"data_sources": [
{
"name": "string",
"type": "string",
"config": {
"clusterName": "Cluster0",
"readPreference": "primary",
"readPreferenceTagSets": [
"server1"
],
"wireProtocolEnabled": true
},
"default_rule": {
"roles": [
{
"document_filters": {
"read": {},
"write": {}
},
"name": "string",
"apply_when": {},
"read": {},
"write": {},
"insert": {},
"delete": {},
"search": {},
"fields": {},
"additional_fields": {
"read": {},
"write": {}
}
}
],
"filters": [
{
"name": "string",
"apply_when": {},
"query": {},
"projection": {
"additionalProperty1": 0,
"additionalProperty2": 0
}
}
]
},
"rules": [
{
"database": "string",
"collection": "string",
"roles": [
{
"document_filters": {
"read": {},
"write": {}
},
"name": "string",
"apply_when": {},
"read": {},
"write": {},
"insert": {},
"delete": {},
"search": {},
"fields": {},
"additional_fields": {
"read": {},
"write": {}
}
}
],
"filters": [
{
"name": "string",
"apply_when": {},
"query": {},
"projection": {
"additionalProperty1": 0,
"additionalProperty2": 0
}
}
]
}
]
}
],
"endpoints": [
{
"route": "string",
"http_method": "GET",
"function_id": "string",
"validation_method": "NO_VALIDATION",
"secret_id": "string",
"return_type": "JSON",
"respond_result": true,
"fetch_custom_user_data": true,
"create_user_on_auth": true,
"disabled": true,
"function_name": "string"
}
],
"environments": {
"values": {
"none": {
"values": {}
},
"development": {
"values": {}
},
"testing": {
"values": {}
},
"qa": {
"values": {}
},
"production": {
"values": {}
}
}
},
"functions": [
{
"can_evaluate": {},
"name": "string",
"private": true,
"source": "string",
"run_as_system": true,
"run_as_user_id": "string",
"run_as_user_id_script_source": "string"
}
],
"graphql": {
"config": {
"use_natural_pluralization": true,
"disable_schema_introspection": true
},
"validation_settings": {
"read_validation_action": "ERROR",
"read_validation_level": "STRICT",
"write_validation_action": "ERROR",
"write_validation_level": "STRICT"
},
"custom_resolvers": [
{
"on_type": "string",
"field_name": "string",
"input_type": "string",
"input_type_format": "scalar",
"payload_type": "string",
"payload_type_format": "scalar",
"function_name": "string"
}
]
},
"hosting": {
"enabled": true,
"custom_domain": "example.com",
"default_error_path": "/404.html",
"default_error_code": "404"
},
"https_endpoints": [
{
"name": "string",
"type": "aws",
"incoming_webhooks": [
{
"name": "string",
"function_source": "string",
"respond_result": true,
"options": {
"secret": "string",
"secretAsQueryParam": true
}
}
],
"version": 42
}
],
"log_forwarders": [
{
"name": "string",
"disabled": true,
"log_types": [
"auth"
],
"log_statuses": [
"error"
],
"policy": {
"type": "single"
},
"action": {
"type": "collection",
"name": "string",
"data_source": "string",
"database": "string",
"collection": "string"
}
}
],
"schemas": [
{
"metadata": {
"data_source": "string",
"database": "string",
"collection": "string"
},
"schema": {
"bsonType": "object",
"title": "string",
"required": [
"string"
],
"properties": {
"*": {}
}
},
"relationships": {
"additionalProperty1": {
"ref": "string",
"foreign_key": "string",
"is_list": true
},
"additionalProperty2": {
"ref": "string",
"foreign_key": "string",
"is_list": true
}
}
}
],
"services": [
{
"name": "string",
"type": "aws",
"incoming_webhooks": [
{
"name": "string",
"function_source": "string",
"respond_result": true,
"options": {
"secret": "string",
"secretAsQueryParam": true
}
}
],
"version": 42
}
],
"sync": {
"state": "string",
"database_name": "string",
"queryable_fields_names": [
"string"
],
"indexed_queryable_fields_names": [
"string"
],
"collection_queryable_fields_names": {
"additionalProperty1": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"additionalProperty2": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
},
"permissions": {},
"last_disabled": "string",
"client_max_offline_days": 42,
"is_recovery_mode_disabled": true,
"asymmetric_tables": [
"string"
]
},
"triggers": [
{
"name": "onNewEmployee",
"type": "DATABASE",
"config": {
"match": {},
"project": {},
"database": "HR",
"collection": "employees",
"service_id": "5adeb649b8b998486770ae7c",
"full_document": true,
"operation_types": [
"INSERT"
]
},
"function_id": "5eea9ca4ca0e356e2c2a148a",
"event_processors": {
"FUNCTION": {
"config": {
"function_id": "6841b8d3e71dc81bed89dbba",
"function_name": "Atlas_Triggers_DatabaseInsert_1749137618"
}
}
}
}
],
"values": [
{
"name": "string",
"private": true,
"from_secret": true
}
]
}