OpenAPI 사양 다운로드: 다운로드
App Services 관리자 API를 사용하면 HTTPS를 통해 프로그래밍 방식으로 관리 작업을 수행할 수 있습니다. 여기에는 정의 및 구성 등의 작업이 포함됩니다.
관리자 API는 애플리케이션 개발, 구성 및 배포를 위한 것입니다. 관리자 API로 구성한 기능을 실제로 사용하려면 클라이언트 애플리케이션을 Atlas Device SDK 또는 앱 전용 HTTPS API를 통해 연결해야 합니다.
참고: 프로젝트 ID와 그룹 ID라는 용어는 서로 바꿔 사용할 수 있습니다.
Atlas App Services 관리자 API 엔드포인트의 경우 URL에 두 개의 매개변수를 포함해야 하는 경우가 많습니다.
프로젝트 ID는 MongoDB Atlas 대시보드 또는 MongoDB Atlas CLI에서 찾을 수 있습니다.
애플리케이션 ID를 찾으려면 프로젝트의 앱 나열 엔드포인트에 요청합니다. 이 요청을 하려면 access_token
이 필요합니다. 토큰 획득 방법을 알아보려면 관리자 API 세션 액세스 토큰 가져오기를 참조하세요.
curl --request GET \
--header 'Authorization: Bearer <access_token>' \
https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps
그러면 제공된 프로젝트/그룹의 각 App Services 앱을 설명하는 객체 목록이 반환됩니다. 관리자 API 요청의 경우 애플리케이션 ID는 client_app_id
가 아니라 _id
필드의 ObjectId 값입니다.
[
{
"_id": "5997529e46224c6e42gb6dd9",
"group_id": "57879f6cc4b32dbe440bb8c5",
"domain_id": "5886619e46124e4c42fb5dd8",
"client_app_id": "myapp-abcde",
"name": "myapp",
"location": "US-VA",
"deployment_model": "GLOBAL",
"last_used": 1615153544,
"last_modified": 0,
"product": "standard",
"environment": ""
}
]
App Services 관리자 API에 대한 모든 요청에는 MongoDB 클라우드 API에서 발급한 유효하고 만료되지 않은 액세스 토큰이 포함되어야 합니다. 베어러 인증 체계를 사용하여 각 요청의 Authorization
헤더에 이 토큰을 포함합니다.
토큰을 가져오려면 MongoDB Atlas에 유효한 MongoDB Atlas 프로그래밍 방식 API 키가 필요합니다.
API 키 쌍이 준비되면 인증 엔드포인트를 호출합니다.
curl --request POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login
인증이 성공하면 App Services는 JSON 응답 문서의 일부로 액세스 토큰을 반환합니다.
{
"access_token": "<access_token>",
"refresh_token": "<refresh_token>",
"user_id": "<user_id>",
"device_id": "<device_id>"
}
access_token
은 관리자 API와 상호 작용할 수 있는 한시적 권한을 나타냅니다. 요청을 인증하려면 베어러 토큰 Authorization
헤더에 토큰을 포함합니다.
Authorization: Bearer <access_token>
세션 액세스 토큰은 발급된 후 30분 후에 만료됩니다. 로그인하면 응답에 새 액세스 토큰을 얻는 데 사용할 수 있는 refresh_token
도 포함됩니다. 자격 증명을 사용하여 한 번만 로그인하면 되기 때문에 유용합니다. 그 후에는 새로 고침 토큰을 사용하여 토큰이 유효한 기간 동안 재인증할 수 있습니다.
기본적으로 새로 고침 토큰은 발행 후 60일 후에 만료됩니다. 새로 고침 토큰 만료를 최소 30분 또는 최대 5년으로 사용자 지정할 수 있습니다.
인증을 새로 고치고 새 access_token
을 가져오려면 Authorization
헤더에 refresh_token
을 사용하여 인증 세션 엔드포인트를 호출합니다.
curl --request POST \
--header 'Authorization: Bearer <refresh_token>' \
https://services.cloud.mongodb.com/api/admin/v3.0/auth/session
새로 고침 토큰이 유효한 경우 응답 본문에는 다음 30분 동안 유효한 새 access_token
이 포함됩니다.
{
"access_token": "<access_token>"
}
Atlas 프로그래밍 방식 API 키 쌍을 사용하여 App Services 관리자로 인증합니다. 자세한 내용은 관리자 API 세션 액세스 토큰 가져오기를 참조하세요.
사용자 이름 필수 | 문자열 |
apiKey 필수 | 문자열 |
{- "username": "string",
- "apiKey": "string"
}
{- "access_token": "string",
- "refresh_token": "string",
- "user_id": "string",
- "device_id": "string"
}
{- "user_id": "string",
- "domain_id": "string",
- "identities": [
- {
- "id": "string",
- "provider_type": "anon-user",
- "provider_id": "string"
}
], - "data": {
- "email": "string",
- "name": "string"
}, - "type": "normal",
- "roles": [
- {
- "role_name": "string",
- "group_id": "string"
}
]
}
API 키 제공자를 통해 API 키를 보고 관리합니다.
Atlas App Services 앱과 연결된 API 키를 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "name": "string",
- "disabled": true
}
]
새 API 키를 생성합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 API 키입니다.
이름 필수 | 문자열 |
{- "name": "string"
}
{- "_id": "string",
- "key": "string",
- "name": "string",
- "disabled": "string"
}
API 키에 대한 정보를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
apiKeyId 필수 | 문자열 API 키의 고유한 |
{- "_id": "string",
- "name": "string",
- "disabled": "string"
}
API 키를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
apiKeyId 필수 | 문자열 API 키의 고유한 |
API 키를 활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
apiKeyId 필수 | 문자열 API 키의 고유한 |
API 키를 비활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
apiKeyId 필수 | 문자열 API 키의 고유한 |
Atlas 프로젝트/그룹 내의 모든 App Services 앱을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
제품 | 문자열 열거형: "standard" "atlas" "data-api" "device-sync" 하나 이상의 특정 App Services 제품 유형입니다. 지정된 경우 이 엔드포인트는 지정된 제품 유형의 앱만 반환합니다. 대부분의 앱은 이 엔드포인트가 기본적으로 반환하는 여러 제품 유형을 쉼표로 구분된 목록으로 지정할 수 있습니다.
|
[- {
- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "_id": "633209ffd3bd3478005d1bac",
- "client_app_id": "myapp-abcde",
- "domain_id": "63320a2b5f9de9a6e0a213e8",
- "group_id": "5b2ec991973129243223a114",
- "last_used": 1664224746,
- "last_modified": 1656440824,
- "product": "standard"
}
]
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
기본값 | 부울 기본 애플리케이션을 만들지 여부입니다. |
제품 | 문자열 열거형: "standard" "atlas" "data-api" "device-sync" 앱의 제품 유형입니다. 앱은 기본적으로
|
생성할 애플리케이션입니다.
이름 | 문자열 애플리케이션의 이름입니다. 문자로 시작해야 하며 ASCII 문자, 숫자, 밑줄, 하이픈만 포함할 수 있습니다. |
AwsDeploymentRegion(문자열) 또는 AzureDeploymentRegion(문자열) 또는 GcpDeploymentRegion(문자열) (CloudProviderRegionId) | |
위치 | 문자열 (DeploymentLocation) 열거형: "US-VA" "US-OR" "DE-FF" "IE" "AU" "IN-MB" "SG" "BR-SP" 애플리케이션의 실제 배포 위치입니다. 이 값은 보다 구체적인 |
deployment_model | |
환경 | 문자열 (NullableAppEnvironment) 열거형: "development" "testing" "qa" "production" "" 애플리케이션의 환경입니다. 빈 문자열은 앱에 지정된 환경이 없음을 나타냅니다. |
template_id | 문자열 새 앱의 기반으로 사용할 App Services 템플릿 앱의 ID입니다. |
AtlasCluster(객체) 또는 AtlasFederatedInstance(객체) (DataSource) |
{- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "template_id": "string",
- "data_source": {
- "name": "string",
- "type": "string"
}
}
{- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "_id": "633209ffd3bd3478005d1bac",
- "client_app_id": "myapp-abcde",
- "domain_id": "63320a2b5f9de9a6e0a213e8",
- "group_id": "5b2ec991973129243223a114",
- "last_used": 1664224746,
- "last_modified": 1656440824,
- "product": "standard"
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "_id": "633209ffd3bd3478005d1bac",
- "client_app_id": "myapp-abcde",
- "domain_id": "63320a2b5f9de9a6e0a213e8",
- "group_id": "5b2ec991973129243223a114",
- "last_used": 1664224746,
- "last_modified": 1656440824,
- "product": "standard"
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
내보내기 엔드포인트는 더 이상 사용되지 않습니다. 대신 Accept: application/zip
헤더를 사용하여 앱 구성 파일 가져오기 엔드포인트를 호출합니다.
애플리케이션을 zip 파일로 내보냅니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
배포 | 문자열 예시: deployment=6373362f01a569d5cd571c68 내보낼 특정 배포의 |
source_control | 부울 기본값입니다: 거짓
|
template | 부울 기본값입니다: 거짓
|
버전 | 문자열 예시: version=20210101 내보낼 구성 파일 스키마 버전입니다. 이 값은 |
현재 앱 구성을 다운로드합니다. 두 가지 형식으로 다운로드하도록 선택할 수 있습니다.
구성 파일 디렉토리가 포함된 압축된 zip 파일입니다. 이는 CLI, 버전 제어 시스템 또는 파일 시스템 기반의 다른 환경으로 작업할 때 가장 유용합니다.
전체 구성을 포함하는 단일 JSON 객체입니다. 이는 API 또는 JSON을 구문 분석할 수 있는 다른 환경으로 작업할 때 가장 유용합니다.
Accept
헤더를 설정하여 다운로드할 형식을 지정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "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": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}, - "rules": [
- {
- "database": "string",
- "collection": "string",
- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 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": {
- "property1": null,
- "property2": null
}
}, - "development": {
- "values": {
- "property1": null,
- "property2": null
}
}, - "testing": {
- "values": {
- "property1": null,
- "property2": null
}
}, - "qa": {
- "values": {
- "property1": null,
- "property2": null
}
}, - "production": {
- "values": {
- "property1": null,
- "property2": null
}
}
}
}, - "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": 0
}
], - "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": {
- "property1": { },
- "property2": { }
}
}, - "relationships": {
- "property1": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}, - "property2": {
- "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": 0
}
], - "sync": {
- "state": "string",
- "database_name": "string",
- "queryable_fields_names": [
- "string"
], - "indexed_queryable_fields_names": [
- "string"
], - "collection_queryable_fields_names": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "permissions": { },
- "last_disabled": "string",
- "client_max_offline_days": 0,
- "is_recovery_mode_disabled": true,
- "asymmetric_tables": [
- "string"
]
}, - "triggers": [
- {
- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
], - "values": [
- {
- "name": "string",
- "private": true,
- "from_secret": true,
- "value": null
}
]
}
새로운 전체 앱 구성을 업로드합니다. 이 작업은 기존 앱 구성 전체를 덮어씁니다.
참고: 앱 구성에 시크릿에 대한 참조가 포함되어 있는 경우 구성을 푸시하기 전에 시크릿을 생성해야 합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이름 필수 | 문자열 앱의 이름입니다. |
필수 | AwsDeploymentRegion(문자열) 또는 AzureDeploymentRegion(문자열) 또는 GcpDeploymentRegion(문자열) (CloudProviderRegionId) |
deployment_model 필수 | |
환경 | 문자열 (AppEnvironment) 열거형: "development" "testing" "qa" "production" 앱의 환경 태그입니다. 지정하지 않으면 앱에 환경 태그가 없습니다. |
필수 | 의 배열 AnonymousAuthProvider(객체) 또는 EmailPasswordAuthProvider(객체) 또는 ApiKeyAuthProvider(객체) 또는 CustomJwtAuthProvider(객체) 또는 CustomFunctionAuthProvider(객체) 또는 AppleAuthProvider(객체) 또는 GoogleAuthProvider(객체) 또는 FacebookAuthProvider(객체) (AuthProviderConstructor) |
CustomUserDataConstructor(객체) 또는 null | |
DataApiConfig(객체) 또는 null | |
필수 | 의 배열 AtlasClusterConstructor(객체) 또는 AtlasFederatedInstanceConstructor(객체) (DataSourceConstructor) |
필수 | 의 배열 객체 (EndpointConstructor) |
필수 | 객체 (AllEnvironmentValues) |
필수 | 의 배열 객체 (FunctionConstructor) |
필수 | 객체 (GraphQLConstructor) |
필수 | 객체 (HostingConstructor) |
필수 | 의 배열 객체 (ThirdPartyServiceConstructor) [더 이상 사용되지 않음] 레거시 HTTP 서비스 목록입니다. 이는 이전 버전과의 호환성을 위한 용도로만 사용됩니다. |
필수 | 의 배열 객체 (LogForwarderConstructor) |
필수 | 의 배열 객체 (FullSchema) |
필수 | 의 배열 객체 (ThirdPartyServiceConstructor) [더 이상 사용되지 않음] 레거시 타사 비 HTTP 서비스 목록입니다. 이는 이전 버전과의 호환성을 위한 용도로만 사용됩니다. |
필수 | 객체 (FlexibleSync) |
필수 | 의 배열 DatabaseTrigger(객체) 또는 AuthenticationTrigger(객체) 또는 ScheduledTrigger(객체) (TriggerConstructor) |
필수 | 의 배열 객체 (ValueConstructor) |
{- "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": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}, - "rules": [
- {
- "database": "string",
- "collection": "string",
- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 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": {
- "property1": null,
- "property2": null
}
}, - "development": {
- "values": {
- "property1": null,
- "property2": null
}
}, - "testing": {
- "values": {
- "property1": null,
- "property2": null
}
}, - "qa": {
- "values": {
- "property1": null,
- "property2": null
}
}, - "production": {
- "values": {
- "property1": null,
- "property2": null
}
}
}
}, - "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": 0
}
], - "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": {
- "property1": { },
- "property2": { }
}
}, - "relationships": {
- "property1": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}, - "property2": {
- "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": 0
}
], - "sync": {
- "state": "string",
- "database_name": "string",
- "queryable_fields_names": [
- "string"
], - "indexed_queryable_fields_names": [
- "string"
], - "collection_queryable_fields_names": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "permissions": { },
- "last_disabled": "string",
- "client_max_offline_days": 0,
- "is_recovery_mode_disabled": true,
- "asymmetric_tables": [
- "string"
]
}, - "triggers": [
- {
- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
], - "values": [
- {
- "name": "string",
- "private": true,
- "from_secret": true,
- "value": null
}
]
}
인증 제공자를 보고 관리합니다.
Atlas App Services 앱 내에서 인증 제공자를 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "name": "string",
- "type": "anon-user",
- "disabled": true
}
]
인증 제공자를 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이름 필수 | 문자열 인증 제공자의 이름입니다. 이 값은 값: "anon-user" |
유형 필수 | 문자열 열거형: "anon-user" "local-userpass" "api-key" "oauth2-apple" "oauth2-google" "oauth2-facebook" "custom-token" "custom-function" 인증 제공자의 이름입니다. 익명 인증의 경우 이 값은 항상 값: "anon-user" |
비활성화 | 부울
|
{- "name": "anon-user",
- "type": "anon-user",
- "disabled": true
}
{- "name": "anon-user",
- "type": "anon-user",
- "disabled": true,
- "_id": "string"
}
애플리케이션의 인증 제공자 중 하나에 대한 정보를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
providerId 필수 | 문자열 인증 제공자의 고유한 |
{- "name": "anon-user",
- "type": "anon-user",
- "disabled": true,
- "_id": "string"
}
인증 제공자를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
providerId 필수 | 문자열 인증 제공자의 고유한 |
인증 제공자를 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
providerId 필수 | 문자열 인증 제공자의 고유한 |
이름 필수 | 문자열 인증 제공자의 이름입니다. 이 값은 값: "anon-user" |
유형 필수 | 문자열 열거형: "anon-user" "local-userpass" "api-key" "oauth2-apple" "oauth2-google" "oauth2-facebook" "custom-token" "custom-function" 인증 제공자의 이름입니다. 익명 인증의 경우 이 값은 항상 값: "anon-user" |
비활성화 | 부울
|
{- "name": "anon-user",
- "type": "anon-user",
- "disabled": true
}
인증 제공자를 비활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
providerId 필수 | 문자열 인증 제공자의 고유한 |
인증 제공자를 활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
providerId 필수 | 문자열 인증 제공자의 고유한 |
청구 목적에 대해 특정 기간 동안 요청, 계산, 동기화 및 데이터 전송 사용량을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
시작하기 | 문자열 쿼리 기간이 시작되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 달의 1일 00:00:00 UTC입니다. |
end | 문자열 쿼리 기간이 종료되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 월 마지막 날의 23:59:59 UTC입니다. |
세분성 | 문자열 열거형: "P31D" "PT1H" 쿼리 기간의 세분성을 P31D(31일) 또는 PT1H(1시간)로 지정합니다. 기본값은 P31D입니다. |
{- "start": "string",
- "end": "string",
- "granularity": "string",
- "group_id": "string",
- "measurements": [
- {
- "name": "request_count",
- "units": "<empty string>",
- "data_points": [
- {
- "timestamp": "string",
- "value": 0
}
]
}
]
}
청구 목적에 대해 특정 기간 동안 특정 앱의 요청, 계산, 동기화, 데이터 전송 및 메모리 사용량을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
시작하기 | 문자열 쿼리 기간이 시작되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 달의 1일 00:00:00 UTC입니다. |
end | 문자열 쿼리 기간이 종료되는 ISO 8601 날짜 및 시간입니다. 기본값은 현재 월 마지막 날의 23:59:59 UTC입니다. |
세분성 | 문자열 열거형: "P31D" "PT1H" 쿼리 기간의 세분성을 P31D(31일) 또는 PT1H(1시간)로 지정합니다. 기본값은 P31D입니다. |
{- "start": "string",
- "end": "string",
- "granularity": "string",
- "group_id": "string",
- "appId": "string",
- "appName": "string",
- "measurements": [
- {
- "name": "request_count",
- "units": "<empty string>",
- "data_points": [
- {
- "timestamp": "string",
- "value": 0
}
]
}
]
}
사용자 지정 사용자 데이터를 구성합니다.
Atlas App Services 앱에 대한 사용자 지정 사용자 데이터 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "database_name": "myapp",
- "collection_name": "users",
- "user_id_field": "user_account_id",
- "enabled": true,
- "mongo_service_id": "63c060ed32043ef4c93c2a9c",
- "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}
Atlas App Services 앱에 대한 사용자 지정 사용자 데이터 구성을 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
database_name | 문자열 사용자 지정 사용자 데이터가 포함된 데이터베이스의 이름입니다. |
collection_name | 문자열 사용자 지정 사용자 데이터가 포함된 컬렉션의 이름입니다. |
user_id_field | 문자열 모든 사용자 지정 사용자 데이터 문서에 표시되고 각 문서에 해당하는 사용자의 사용자 계정 ID를 포함하는 필드의 이름입니다. |
활성화됨 | 부울
|
mongo_service_id | 문자열 연결된 MongoDB 데이터 소스 의 _id 값입니다. 모든 서비스 가져오기 엔드포인트 를 사용하여 서비스를 나열할 수 있습니다. 데이터 소스는 |
on_user_creation_function_id | 문자열 새 사용자가 등록할 때마다 실행되는 사용자 생성 함수의 |
{- "database_name": "myapp",
- "collection_name": "users",
- "user_id_field": "user_account_id",
- "enabled": true,
- "mongo_service_id": "63c060ed32043ef4c93c2a9c",
- "on_user_creation_function_id": "63c055d8019a6ab879f661d6"
}
초안을 만들고 배포하여 애플리케이션 변경 사항 그룹을 함께 배포할 수 있습니다. 일련의 초안 변경 사항을 생성하고 배포하려면 다음을 수행합니다.
초안은 단일 단위로 배포하거나 삭제할 수 있는 애플리케이션 변경 사항 그룹을 나타냅니다. 초안을 만들려면 초안 엔드포인트에 POST
요청을 보냅니다.
curl --request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token>' \
'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts'
각 사용자는 UI나 관리자 API를 통해 한 번에 1개 초안만 만들 수 있습니다. 기존 초안이 이미 있는 경우 초안의 엔드포인트에 DELETE
요청을 전송하여 기존 초안과 관련된 변경 사항을 삭제할 수 있습니다.
curl --request DELETE \
--header 'Authorization: Bearer <access_token>' \
'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}'
초안을 만든 후에는 초안에 포함할 내용을 변경 사항을 모두 적용합니다. App Services는 함께 배포할 수 있도록 초안에 대한 모든 애플리케이션 변경 사항을 추가합니다.
배포에 포함하려는 변경 사항을 모두 적용한 후 해당 초안의 배포 엔드포인트에 POST
요청을 전송하여 초안을 배포합니다.
curl --request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token>' \
'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment'
API를 통해 변경 사항을 배포했는데 UI의 초안에서 변경 사항이 충돌하는 경우 UI 초안이 유효하지 않게 되어 배포할 수 없게 됩니다. Deployment
페이지에서 초안을 검토하여 UI 초안을 다운로드할 수 있습니다. 다운로드를 사용하여 appservices
CLI에서 변경 사항을 배포하거나 UI에서 변경 사항을 다시 적용할 때 참조로 사용할 수 있습니다.
앱이 변경 사항을 배포하는 방법에 대한 정보를 참조하세요.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "ui_drafts_disabled": true,
- "automatic_deployment": {
- "enabled": true,
- "provider": "github",
- "installation_ids": [
- "string"
]
}, - "last_modified": 0
}
앱의 배포 구성을 수정하여 앱이 변경 사항을 배포하는 방식을 사용자 지정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
ui_drafts_disabled 필수 | 부울
|
필수 | 객체 자동 배포 메서드 구성 |
last_modified | 숫자 이 구성이 마지막으로 수정된 시간은 유닉스 시간 이후의 시간(초)으로 표시됩니다. |
{- "ui_drafts_disabled": true,
- "automatic_deployment": {
- "enabled": true,
- "provider": "github",
- "installation_ids": [
- "string"
]
}, - "last_modified": 0
}
가장 최근에 배포된 애플리케이션 25개를 반환합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "name": "string",
- "app_id": "string",
- "draft_id": "string",
- "user_id": "string",
- "deployed_at": 0,
- "origin": "string",
- "commit": "string",
- "status": "string",
- "status_error_message": "string",
- "diff_url": "string",
- "remote_location": "US-VA"
}
]
애플리케이션의 최근 배포에 대한 정보를 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
deploymentId 필수 | 문자열 애플리케이션 배포의 |
{- "_id": "string",
- "name": "string",
- "app_id": "string",
- "draft_id": "string",
- "user_id": "string",
- "deployed_at": 0,
- "origin": "string",
- "commit": "string",
- "status": "string",
- "status_error_message": "string",
- "diff_url": "string",
- "remote_location": "US-VA"
}
이전에 배포한 버전의 앱을 다시 배포합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
deploymentId 필수 | 문자열 애플리케이션 배포의 |
{- "error": "deployment not found",
- "error_code": "DeploymentNotFound"
}
해당되는 경우 현재 애플리케이션 배포 초안을 반환합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "_id": "string",
- "user_id": "string",
- "app": {
- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "_id": "633209ffd3bd3478005d1bac",
- "client_app_id": "myapp-abcde",
- "domain_id": "63320a2b5f9de9a6e0a213e8",
- "group_id": "5b2ec991973129243223a114",
- "last_used": 1664224746,
- "last_modified": 1656440824,
- "product": "standard"
}
}
애플리케이션 배포 초안이 없는 경우 새 애플리케이션 배포 초안을 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "_id": "string",
- "user_id": "string",
- "app": {
- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "_id": "633209ffd3bd3478005d1bac",
- "client_app_id": "myapp-abcde",
- "domain_id": "63320a2b5f9de9a6e0a213e8",
- "group_id": "5b2ec991973129243223a114",
- "last_used": 1664224746,
- "last_modified": 1656440824,
- "product": "standard"
}
}
지정된 애플리케이션 배포 초안을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
draftId 필수 | 문자열 초안의 고유한 |
지정된 애플리케이션 배포 초안을 배포합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
draftId 필수 | 문자열 초안의 고유한 |
이름 필수 | 문자열 배포의 이름입니다. 이름 없이 초안을 배포하려면 빈 문자열을 사용합니다. |
{- "name": "string"
}
{- "_id": "string",
- "name": "string",
- "app_id": "string",
- "draft_id": "string",
- "user_id": "string",
- "deployed_at": 0,
- "origin": "string",
- "commit": "string",
- "status": "string",
- "status_error_message": "string",
- "diff_url": "string",
- "remote_location": "US-VA"
}
현재 배포된 애플리케이션과 지정된 초안 간의 차이점을 반환합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
draftId 필수 | 문자열 초안의 고유한 |
{- "diffs": [
- "string"
], - "hosting_files_diff": {
- "added": [
- "string"
], - "deleted": [
- "string"
], - "modified": [
- "string"
]
}
}
현재 배포 마이그레이션에 대한 메타데이터와 상태를 가져옵니다(있는 경우).
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "status": "started",
- "message": "string",
- "updated_at": "string",
- "from": {
- "deployment_model": "GLOBAL",
- "provider_region": "aws-us-east-1"
}, - "to": {
- "deployment_model": "GLOBAL",
- "provider_region": "aws-us-east-1"
}
}
새 배포 마이그레이션을 시작합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
앱이 마이그레이션해야 하는 배포 모델 및 클라우드 공급자 리전
deployment_model | |
AwsDeploymentRegion(문자열) 또는 AzureDeploymentRegion(문자열) 또는 GcpDeploymentRegion(문자열) (CloudProviderRegionId) |
{- "deployment_model": "LOCAL",
- "provider_region": "aws-us-east-1"
}
앱에서 생성된 데이터 API 엔드포인트를 관리합니다.
데이터 API 요청은 앱 및 배포 모델에 고유한 기본 URL을 사용합니다.
글로벌로 배포된 앱의 경우 기본 URL의 형식은 다음과 같습니다.
https://data.mongodb-api.com/app/{ClientAppID}/endpoint/data/{DataAPIVersion}
로컬로 배포된 앱은 유사한 기본 URL을 사용하며 앱의 배포 리전과 클라우드 공급자도 포함합니다.
https://{Region}.{Cloud}.data.mongodb-api.com/app/{ClientAppID}/endpoint/data/{DataAPIVersion}
앱 구성에서 앱의 Region
, Cloud
및 ClientAppId
를 찾을 수 있습니다.
curl -X GET https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId} \
-h 'Authorization: Bearer <AccessToken>'
데이터 API 구성의 versions
필드에서 앱에서 지원하는 모든 DataAPIVersion
값 목록을 볼 수 있습니다.
curl -X GET "https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/data_api/config" \
-h 'Authorization: Bearer <AccessToken>'
예를 들어 다음과 같은 구성이 있는 앱을 가정해 보겠습니다.
{
"client_app_id": "myapp-abcde",
"deployment_model": "LOCAL",
"provider_region": "aws-us-east-1",
...
}
이 앱은 데이터 API v1 요청에 대해 다음 기본 URL을 사용합니다.
https://us-east-1.aws.data.mongodb-api.com/app/myapp-abcde/endpoint/data/v1
앱의 데이터 API 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "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": { }
}
앱의 데이터 API 구성을 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
엔드포인트에 대한 유효한 구성 객체입니다.
비활성화 필수 | 부울 |
versions 필수 | 의 배열 strings (DataApiVersion) 아이템 값: "v1" |
return_type 필수 | |
create_user_on_auth | 부울 |
run_as_user_id | 문자열 애플리케이션 사용자의 계정 ID. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다. |
run_as_user_id_script_source | 문자열 애플리케이션 사용자의 계정 ID를 반환하는 함수에 대한 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다. |
validation_method 필수 | 문자열 열거형: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD" |
secret_name | 문자열
|
can_evaluate | 객체 수신 요청에 대한 응답으로 엔드포인트의 실행이 허용되는 경우 |
{- "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": { }
}
{- "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": { }
}
앱의 데이터 API 구성을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
엔드포인트에 대한 유효한 구성 객체입니다.
비활성화 필수 | 부울 |
versions 필수 | 의 배열 strings (DataApiVersion) 아이템 값: "v1" |
return_type 필수 | |
create_user_on_auth | 부울 |
run_as_user_id | 문자열 애플리케이션 사용자의 계정 ID. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다. |
run_as_user_id_script_source | 문자열 애플리케이션 사용자의 계정 ID를 반환하는 함수에 대한 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다. |
validation_method 필수 | 문자열 열거형: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD" |
secret_name | 문자열
|
can_evaluate | 객체 수신 요청에 대한 응답으로 엔드포인트의 실행이 허용되는 경우 |
{- "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": { }
}
가능한 모든 데이터 API 버전을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- "v1"
]
애플리케이션의 외부 종속성을 관리합니다.
Atlas App Services 앱에 업로드된 외부 종속성을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "_id": "string",
- "location": "string",
- "user_id": "string",
- "last_modified": 0,
- "dependencies_list": [
- {
- "name": "string",
- "version": "string"
}
]
}
앱의 사용자 지정 HTTPS 엔드포인트를 보고 관리합니다.
HTTPS 엔드포인트 요청은 앱 및 배포 모델과 관련된 기본 URL을 사용합니다.
글로벌로 배포된 앱의 경우 기본 URL의 형식은 다음과 같습니다.
https://data.mongodb-api.com/app/{ClientAppID}/endpoint
로컬로 배포된 앱은 유사한 기본 URL을 사용하며 앱의 배포 리전과 클라우드 공급자도 포함합니다.
https://{Region}.{Cloud}.data.mongodb-api.com/app/{ClientAppID}/endpoint
앱 가져오기 엔드포인트를 호출하여 앱의 Region
, Cloud
및 ClientAppId
를 찾을 수 있습니다.
curl -X GET https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId} \
-h 'Authorization: Bearer <AccessToken>'
예를 들어 다음과 같은 구성이 있는 앱을 가정해 보겠습니다.
{
"client_app_id": "myapp-abcde",
"deployment_model": "LOCAL",
"provider_region": "aws-us-east-1",
...
}
이 앱은 수신되는 사용자 지정 HTTPS 엔드포인트 요청에 대해 다음 기본 URL을 사용합니다.
https://us-east-1.aws.data.mongodb-api.com/app/myapp-abcde/endpoint
모든 엔드포인트 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "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,
- "_id": "string",
- "function_name": "string"
}
]
새 엔드포인트를 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
새 엔드포인트에 대한 유효한 구성 객체입니다.
루트 필수 | 문자열 |
http_method 필수 | 문자열 열거형: "GET" "POST" "PUT" "PATCH" "DELETE" "*" |
function_id 필수 | 문자열 엔드포인트 함수의 고유 ID입니다. |
validation_method 필수 | 문자열 열거형: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD" |
secret_id | 문자열
|
return_type 필수 | |
respond_result 필수 | 부울 |
fetch_custom_user_data | 부울 |
create_user_on_auth | 부울 |
비활성화 필수 | 부울 |
_id | 문자열 엔드포인트의 고유 ID입니다. |
{- "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,
- "_id": "string"
}
{- "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,
- "_id": "string",
- "function_name": "string"
}
특정 엔드포인트의 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
endpointId 필수 | 문자열 엔드포인트의 고유한 |
{- "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,
- "_id": "string",
- "function_name": "string"
}
기존 엔드포인트 구성을 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
endpointId 필수 | 문자열 엔드포인트의 고유한 |
엔드포인트에 대해 유효하고 업데이트된 구성 객체입니다.
루트 필수 | 문자열 |
http_method 필수 | 문자열 열거형: "GET" "POST" "PUT" "PATCH" "DELETE" "*" |
function_id 필수 | 문자열 엔드포인트 함수의 고유 ID입니다. |
validation_method 필수 | 문자열 열거형: "NO_VALIDATION" "SECRET_AS_QUERY_PARAM" "VERIFY_PAYLOAD" |
secret_id | 문자열
|
return_type 필수 | |
respond_result 필수 | 부울 |
fetch_custom_user_data | 부울 |
create_user_on_auth | 부울 |
비활성화 필수 | 부울 |
_id | 문자열 엔드포인트의 고유 ID입니다. |
{- "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,
- "_id": "string"
}
{- "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,
- "_id": "string",
- "function_name": "string"
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
endpointId 필수 | 문자열 엔드포인트의 고유한 |
{ }
앱의 활성 이벤트 구독을 확인합니다. 이는 예를 들어 MongoDB 변경 스트림에서 실시간 이벤트를 모니터링하여 트리거 및 Device Sync와 같은 애플리케이션 서비스를 구동합니다.
모든 이벤트 구독을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
유형 | 문자열 열거형: "DATABASE" "AUTHENTICATION" "SCHEDULED" "SYNCTRANSLATOR" 반환할 이벤트 구독 유형입니다.
|
[- {
- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
]
이벤트 구독에 대한 정보를 반환합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
eventSubscriptionId 필수 | 문자열 이벤트 구독의 고유한 |
{- "_id": "string",
- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
가장 최근에 실행된 이벤트 구독에 대한 정보를 반환합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
eventSubscriptionId 필수 | 문자열 이벤트 구독의 고유한 |
{- "data": { },
- "resource_id": { },
- "completed_at": { },
- "cluster_time": { }
}
앱의 환경 및 환경 값을 보고 관리합니다.
앱의 활성 환경 설정
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
환경 | 문자열 (NullableAppEnvironment) 열거형: "development" "testing" "qa" "production" "" 애플리케이션의 환경입니다. 빈 문자열은 앱에 지정된 환경이 없음을 나타냅니다. |
{- "environment": "production"
}
{- "name": "MyApp",
- "provider_region": "aws-us-east-1",
- "location": "US-VA",
- "deployment_model": "GLOBAL",
- "environment": "production",
- "_id": "633209ffd3bd3478005d1bac",
- "client_app_id": "myapp-abcde",
- "domain_id": "63320a2b5f9de9a6e0a213e8",
- "group_id": "5b2ec991973129243223a114",
- "last_used": 1664224746,
- "last_modified": 1656440824,
- "product": "standard"
}
앱의 모든 환경 값에 대한 기본 정보를 가져옵니다. 결과에는 환경별 values
가 포함되지 않습니다. 특정 환경에 대한 자세한 내용을 보려면 환경 값 가져오기를 호출합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "name": "string",
- "last_modified": 0
}
]
새 환경 값을 정의합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
_id | 문자열 환경 값의 내부 ID |
이름 | 문자열 환경 값 이름 |
last_modified | 숫자 이 구성이 마지막으로 수정된 시간은 유닉스 시간 이후의 시간(초)으로 표시됩니다. |
객체 환경 이름을 값에 매핑하는 객체입니다. 환경 값은 현재 활성 환경의 매핑된 값으로 해석됩니다. 현재 활성 환경에 매핑된 값이 없으면 환경 값은 |
{- "_id": "string",
- "name": "string",
- "last_modified": 0,
- "values": {
- "none": null,
- "development": null,
- "testing": null,
- "qa": null,
- "production": null
}
}
{- "_id": "string",
- "name": "string",
- "last_modified": 0
}
특정 환경 값 세부 정보 가져오기
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
environmentValueId 필수 | 문자열 환경 값의 |
{- "_id": "string",
- "name": "string",
- "last_modified": 0,
- "values": {
- "none": null,
- "development": null,
- "testing": null,
- "qa": null,
- "production": null
}
}
기존 환경 값 수정
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
environmentValueId 필수 | 문자열 환경 값의 |
_id | 문자열 환경 값의 내부 ID |
이름 | 문자열 환경 값 이름 |
last_modified | 숫자 이 구성이 마지막으로 수정된 시간은 유닉스 시간 이후의 시간(초)으로 표시됩니다. |
객체 환경 이름을 값에 매핑하는 객체입니다. 환경 값은 현재 활성 환경의 매핑된 값으로 해석됩니다. 현재 활성 환경에 매핑된 값이 없으면 환경 값은 |
{- "_id": "string",
- "name": "string",
- "last_modified": 0,
- "values": {
- "none": null,
- "development": null,
- "testing": null,
- "qa": null,
- "production": null
}
}
{- "_id": "string",
- "name": "string",
- "last_modified": 0
}
기존 환경 값 삭제
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
environmentValueId 필수 | 문자열 환경 값의 |
{- "error": "string",
- "error_code": "EnvironmentValueNotFound"
}
앱의 함수를 보고 관리합니다.
테스트를 위한 함수를 실행합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
user_id 필수 | 문자열 함수를 실행할 사용자입니다. |
run_as_system 필수 | 부울 시스템 사용자로 실행할지 여부를 결정합니다. |
실행할 함수입니다.
서비스 | 문자열 이 함수를 호출할 때 사용할 서비스입니다. |
이름 필수 | 문자열 실행하려는 함수의 이름입니다. |
arguments | 의 배열 strings 함수에 필요한 모든 인수입니다. |
{- "service": "string",
- "name": "string",
- "arguments": [
- "string"
]
}
{- "error": { },
- "logs": null,
- "result": { },
- "stats": {
- "execution_time": "string"
}
}
테스트를 위해 함수의 소스 코드를 실행합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
user_id 필수 | 문자열 함수를 실행할 사용자입니다. |
run_as_system 필수 | 부울 시스템 사용자로 실행할지 여부를 결정합니다. |
실행할 소스입니다.
eval_source | 문자열 함수를 실행하려면 이 JSON 표현식을 |
source 필수 | 문자열 |
{- "eval_source": "string",
- "source": "string"
}
{- "error": { },
- "logs": null,
- "result": { },
- "stats": {
- "execution_time": "string"
}
}
함수를 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "name": "string",
- "last_modified": 0
}
]
새 함수를 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 함수
can_evaluate | 객체 수신 요청에 대한 응답으로 함수의 실행이 허용되는 경 |
이름 필수 | 문자열 함수의 고유 이름입니다. |
비공개 필수 | 부울
|
source 필수 | 문자열 함수의 문자열화된 소스 코드입니다. 코드는 유효한 ES6여야 합니다. |
run_as_system | 부울
|
run_as_user_id | 문자열 애플리케이션 사용자의 계정 ID입니다. 정의된 경우 엔드포인트는 항상 지정된 사용자로 실행됩니다. |
run_as_user_id_script_source | 문자열 애플리케이션 사용자의 계정 ID를 반환하는 함수의 문자열화된 소스 코드입니다. 정의된 경우 엔드포인트는 모든 요청에서 함수를 실행하고 함수에서 반환된 ID를 가진 사용자로 실행됩니다. |
{- "can_evaluate": { },
- "name": "string",
- "private": true,
- "source": "string",
- "run_as_system": true,
- "run_as_user_id": "string",
- "run_as_user_id_script_source": "string"
}
{- "_id": "string",
- "name": "string"
}
함수 를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
functionId 필수 | 문자열 함수의 고유한 |
{- "can_evaluate": { },
- "name": "string",
- "private": true,
- "source": "string",
- "run_as_system": true,
- "run_as_user_id": "string",
- "run_as_user_id_script_source": "string"
}
함수를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
functionId 필수 | 문자열 함수의 고유한 |
함수를 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
functionId 필수 | 문자열 함수의 고유한 |
{- "can_evaluate": { },
- "name": "string",
- "private": true,
- "source": "string",
- "run_as_system": true,
- "run_as_user_id": "string",
- "run_as_user_id_script_source": "string"
}
인증 및 데이터 액세스 규칙을 우회하는 시스템 사용자로 쿼리 또는 변형을 실행합니다. 인트로스펙션 쿼리를 사용하여 스키마를 포함한 API에 대한 메타데이터에 액세스할 수 있습니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
쿼리 필수 | 문자열 API에 대한 하나 이상의 유효한 GraphQL 작업을 포함하는 문자열화된 |
variables | 문자열 각 필드 이름이 지정된 작업의 변수에 값을 매핑하는 문자열화된 JSON 객체입니다. |
operationName | 문자열 실행할 |
{- "query": "query AllTasks { tasks(query: { status: $status }) { _id owner } }",
- "variables": "{ \"status\": \"complete\" }",
- "operationName": "AllTasks"
}
{- "data": { },
- "errors": [
- {
- "message": "string",
- "locations": [
- {
- "line": 0,
- "column": 0
}
]
}
]
}
앱의 GraphQL API 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "use_natural_pluralization": true,
- "disable_schema_introspection": true
}
앱의 GraphQL API 구성을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
유효한 GraphQL API 구성 객체입니다.
use_natural_pluralization | 부울
앱을 생성한 후에는 이 값을 변경할 수 없습니다. 모든 새 앱의 경우 이 값은 |
disable_schema_introspection | 부울
|
{- "use_natural_pluralization": true,
- "disable_schema_introspection": true
}
앱의 GraphQL API에서 모든 사용자 지정 해석기 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "on_type": "string",
- "field_name": "string",
- "input_type": "string",
- "input_type_format": "scalar",
- "payload_type": "string",
- "payload_type_format": "scalar",
- "_id": "string",
- "function_id": "string"
}
]
새 사용자 지정 해석기를 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
유효한 사용자 지정 해석기 구성 객체입니다.
on_type 필수 | 문자열 해석기의 상위 유형 이름입니다. |
field_name 필수 | 문자열 GraphQL 스키마에 표시되는 사용자 지정 해석기 필드의 이름입니다. |
문자열 또는 객체 사용자 지정 해석기의 | |
input_type_format | 문자열 열거형: "scalar" "scalar-list" "generated" "generated-list" "custom" 사용자 지정 해석기가 사용하는 입력 유형의 종류입니다. 이 값은
정의되지 않은 경우 해석기는 입력을 허용하지 않습니다. |
문자열 또는 객체 사용자 지정 해석기가 반환하는 값의 유형입니다. 이는 스칼라, 기존에 생성된 유형의 이름 또는 사용자 지정 JSON schema 객체일 수 있습니다. 정의되지 않은 경우 해석기는
| |
payload_type_format | 문자열 열거형: "scalar" "scalar-list" "generated" "generated-list" "custom" 사용자 지정 해석기가 사용하는 페이로드 유형의 종류입니다. 이 값은
정의되지 않은 경우 해석기는 |
_id 필수 | 문자열 사용자 지정 해석기의 고유 ID입니다. |
function_id 필수 | 문자열 해석기 함수의 고유 ID입니다. |
{- "on_type": "string",
- "field_name": "string",
- "input_type": "string",
- "input_type_format": "scalar",
- "payload_type": "string",
- "payload_type_format": "scalar",
- "_id": "string",
- "function_id": "string"
}
{- "on_type": "string",
- "field_name": "string",
- "input_type": "string",
- "input_type_format": "scalar",
- "payload_type": "string",
- "payload_type_format": "scalar",
- "_id": "string",
- "function_id": "string"
}
특정 사용자 지정 해석기 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
customResolverId 필수 | 문자열 사용자 지정 해석기의 고유한 |
{- "on_type": "string",
- "field_name": "string",
- "input_type": "string",
- "input_type_format": "scalar",
- "payload_type": "string",
- "payload_type_format": "scalar",
- "_id": "string",
- "function_id": "string"
}
기존 사용자 지정 해석기 구성을 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
customResolverId 필수 | 문자열 사용자 지정 해석기의 고유한 |
유효하고 업데이트된 사용자 지정 해석기 구성 객체입니다.
on_type 필수 | 문자열 해석기의 상위 유형 이름입니다. |
field_name 필수 | 문자열 GraphQL 스키마에 표시되는 사용자 지정 해석기 필드의 이름입니다. |
문자열 또는 객체 사용자 지정 해석기의 | |
input_type_format | 문자열 열거형: "scalar" "scalar-list" "generated" "generated-list" "custom" 사용자 지정 해석기가 사용하는 입력 유형의 종류입니다. 이 값은
정의되지 않은 경우 해석기는 입력을 허용하지 않습니다. |
문자열 또는 객체 사용자 지정 해석기가 반환하는 값의 유형입니다. 이는 스칼라, 기존에 생성된 유형의 이름 또는 사용자 지정 JSON schema 객체일 수 있습니다. 정의되지 않은 경우 해석기는
| |
payload_type_format | 문자열 열거형: "scalar" "scalar-list" "generated" "generated-list" "custom" 사용자 지정 해석기가 사용하는 페이로드 유형의 종류입니다. 이 값은
정의되지 않은 경우 해석기는 |
_id 필수 | 문자열 사용자 지정 해석기의 고유 ID입니다. |
function_id 필수 | 문자열 해석기 함수의 고유 ID입니다. |
{- "on_type": "string",
- "field_name": "string",
- "input_type": "string",
- "input_type_format": "scalar",
- "payload_type": "string",
- "payload_type_format": "scalar",
- "_id": "string",
- "function_id": "string"
}
기존 사용자 지정 해석기 구성을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
customResolverId 필수 | 문자열 사용자 지정 해석기의 고유한 |
읽기 및 쓰기에 대한 현재 유효성 검사 수준과 작업을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "read_validation_action": "ERROR",
- "read_validation_level": "STRICT",
- "write_validation_action": "ERROR",
- "write_validation_level": "STRICT"
}
읽기 및 쓰기에 대한 유효성 검사 수준과 작업을 설정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
업데이트된 유효성 검사 수준 및 작업입니다.
read_validation_action | 문자열 (GraphQLValidationAction) 열거형: "error" "WARN" |
read_validation_level | 문자열 (GraphQLValidationLevel) 열거형: "STRICT" "OFF" |
write_validation_action | 문자열 (GraphQLValidationAction) 열거형: "error" "WARN" |
write_validation_level | 문자열 (GraphQLValidationLevel) 열거형: "STRICT" "OFF" |
{- "read_validation_action": "ERROR",
- "read_validation_level": "STRICT",
- "write_validation_action": "ERROR",
- "write_validation_level": "STRICT"
}
애플리케이션의 호스팅된 파일을 관리합니다.
자산 메타데이터 문서는 호스팅된 자산 파일을 설명합니다.
{
"path": "<Asset Resource Path>",
"hash": "<Asset MD5 Checksum Hash>",
"size": <File size in bytes>,
"attrs": [
{
"name": "<Metadata Attribute Name>",
"value": "<Metadata Attribute Value>",
}
]
}
현재 호스팅 구성을 반환합니다. 응답에 status: "setup_ok"
가 포함되어 있으면 호스팅이 활성화된 것입니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "enabled": true,
- "status": "setup_ok",
- "default_domain": {
- "provider_type": "aws",
- "config": {
- "app_default_domain": "myapp-qldqx.mongodbstitch.com"
}
}
}
앱에 대한 App Services 호스팅을 활성화하거나 비활성화합니다. 호스팅 변경 사항이 적용되려면 최대 15분 정도 소요될 수 있습니다. 이 엔드포인트는 변경 사항이 적용된 시점을 알리지 않고 서버에서 변경 작업을 성공적으로 수신했다는 것만 알립니다.
호스팅 구성 가져오기 엔드포인트를 호출하여 호스팅 활성화/비활성화가 완료되었는지 확인할 수 있습니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
활성화됨 | 부울 App Services 호스팅을 활성화하려면 |
{- "enabled": true
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "appId": "string",
- "last_modified": 0,
- "url": "string",
- "path": "string",
- "size": 0,
- "attrs": [
- {
- "name": "string",
- "value": "string"
}
], - "hash": "string"
}
]
호스팅된 자산을 새 리소스 경로로 이동하거나 복사합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
호스팅된 자산 파일과 해당 메타데이터입니다 (Content-Type: multipart/mixed
를 사용해야 함).
move_from | 문자열 이동할 자산의 현재 리소스 경로입니다. |
move_to | 문자열 자산이 이동할 리소스 경로입니다. |
copy_from | 문자열 복사할 자산의 현재 리소스 경로입니다. |
copy_to | 문자열 자산이 복사될 리소스 경로입니다. |
{- "move_from": "string",
- "move_to": "string",
- "copy_from": "string",
- "copy_to": "string"
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
경로 필수 | 문자열 호스팅된 자산의 리소스 경로입니다. |
prefix | 문자열 리소스 경로가 지정된 접두사로 시작하는 자산만 반환합니다. |
{- "appId": "string",
- "last_modified": 0,
- "url": "string",
- "path": "string",
- "size": 0,
- "attrs": [
- {
- "name": "string",
- "value": "string"
}
], - "hash": "string"
}
특정 리소스 경로에서 호스팅된 자산을 업로드하거나 교체합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
경로 필수 | 문자열 호스팅된 자산의 리소스 경로입니다. |
호스팅된 자산 파일과 해당 메타데이터입니다 (Content-Type: multipart/mixed
를 사용해야 함).
객체 (AssetMetadata) 자산 메타데이터 문서(JSON으로 인코딩됨) | |
파일 | 문자열 <binary> 업로드할 자산 파일입니다(바이너리로 인코딩). |
{- "meta": {
- "path": "string",
- "size": 0,
- "attrs": [
- {
- "name": "string",
- "value": "string"
}
], - "hash": "string"
}, - "file": "string"
}
{- "error": "string",
- "error_code": "string"
}
특정 리소스 경로에서 호스팅된 자산의 메타데이터 속성을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
경로 필수 | 문자열 호스팅된 자산의 리소스 경로입니다. |
호스팅된 자산의 새로운 메타데이터 속성입니다. 이러한 속성은 파일의 모든 기존 속성을 대체합니다.
의 배열 객체 (MetadataAttribute) |
{- "attributes": [
- {
- "name": "string",
- "value": "string"
}
]
}
{- "error": "string",
- "error_code": "string"
}
애플리케이션의 로그에 액세스합니다.
로깅 엔드포인트는 페이지당 최대 100개의 로그 항목을 반환합니다. 쿼리가 항목 100개를 초과하여 일치하면 결과가 페이지로 매겨집니다. 이러한 결과에는 동일한 쿼리에 대해 다음 페이지의 항목을 요청하는 데 필요한 두 가지 정보, 즉 nextEndDate
및 nextSkip
필드가 포함됩니다.
페이지가 매겨진 결과에는 항상 nextEndDate
필드가 포함됩니다. 다음 페이지의 첫 번째 항목의 타임스탬프가 현재 페이지의 마지막 항목의 타임스탬프와 동일한 경우 페이지가 매겨진 결과에는 nextSkip
필드도 포함됩니다.
최대 100개의 로그 항목 중 첫 페이지를 요청하려면 평소와 같이 엔드포인트를 사용합니다.
curl --request GET \
--header 'Authorization: Bearer <access_token>' \
'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/logs'
최대 100개의 로그 항목으로 구성된 다음 페이지를 요청하려면 nextEndDate
및 nextSkip
값을 각각 end_date
및 skip
매개변수로 전달합니다.
curl --request GET \
--header 'Authorization: Bearer <access_token>' \
'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/logs?end_date={nextEndDate of previous response}&skip={nextSkip of previous response}'
응답에 nextEndDate
필드가 없을 때까지 이 단계를 반복하여 더 많은 페이지를 가져옵니다. 해당 필드가 없으면 마지막 페이지에 도달했음을 의미합니다.
자세한 내용은 /groups/{groupId}/apps/{appId}/logs 가져오기를 참조하세요.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
co_id | 문자열 특정 요청 상관관계 ID와 관련된 로그 메시지만 반환합니다. |
errors_only | 부울 이 필드의 값은 중요하지 않습니다. 요청에 포함된 경우 이 엔드포인트는 값이 |
user_id | 문자열 특정 |
start_date | 문자열 결과 반환을 시작할 ISO 8601의 날짜 및 시간(배타적)입니다. |
end_date | 문자열 결과 반환을 중단할 ISO 8601의 날짜 및 시간(포괄적)입니다. |
건너뛰기 | integer 응답에 포함하기 전에 건너뛸 일치 로그 항목의 오프셋 수입니다. |
limit | integer [ 1 .. 100 ] 응답에 포함할 최대 로그 항목 수입니다. 쿼리가 이 수보다 많은 로그와 일치하는 경우 한도에 도달할 때까지 날짜별 오름차순으로 문서를 반환합니다. |
유형 | 문자열 열거형: "TRIGGER_FAILURE" "TRIGGER_ERROR_ANDLER" "DB_TRIGGER" "AUTH_TRIGGER" "SCHEDULED_TRIGGER" "function" "SERVICE_FUNCTION" "STREAM_FUNCTION" "SERVICE_STREAM_FUNCTION" "auth" "WEBHOOK" "ENDPOINT" "push" "API" "API_KEY" "graphql" "SYNC_CONNECTION_START" "SYNC_CONNECTION_END" "SYNC_SESSION_START" "SYNC_SESSION_END" "SYNC_CLIENT_WRITE" "SYNC_ERROR" "SYNC_OTHER" "SCHEMA_ADDITIVE_CHANGE" "SCHEMA_GENERATION" "SCHEMA_VALIDATION" "LOG_FORWARDER" 조회하려는 로그의 종류입니다. |
{- "logs": [
- {
- "_id": "63922bf071bdce7b19e14e76",
- "co_id": "63922bf071bdce7b19e14e75",
- "domain_id": "60c8f69884b0a73d14bb634b",
- "app_id": "60c8f69884b0a73d14bb634a",
- "group_id": "5b2ec426970199272441a214",
- "request_url": "/api/client/v2.0/app/test-for-now-vbwlr/auth/providers/anon-user/login",
- "request_method": "POST",
- "started": "2022-12-08T18:24:48.409Z",
- "completed": "2022-12-08T18:24:48.41Z",
- "type": "API"
}
], - "nextEndDate": "string",
- "nextSkip": 0
}
애플리케이션의 로그 전달자를 보고 관리합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "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"
}
}
]
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
로그 전달자 구성
이름 필수 | 문자열 |
비활성화 필수 | 부울 |
log_types 필수 | 의 배열 strings (LogType) 항목 열거형: "AUTH" "ENDPOINT" "FUNCTION" "GRAPHQL" "PUSH" "schema" "service" "sync" "trigger" "trigger_error_Handler" |
log_statuses 필수 | 의 배열 strings (LogStatus) 항목 열거형: "ERROR" "success" |
필수 | 객체 (LogForwardingPolicy) |
필수 | 객체 (LogForwardingAction) |
{- "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"
}
}
{- "_id": "string",
- "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"
}
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
forwarderId 필수 | 문자열 로그 전달자의 _id ObjectID입니다. |
{- "_id": "string",
- "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"
}
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
forwarderId 필수 | 문자열 로그 전달자의 _id ObjectID입니다. |
로그 전달자 구성
이름 필수 | 문자열 |
비활성화 필수 | 부울 |
log_types 필수 | 의 배열 strings (LogType) 항목 열거형: "AUTH" "ENDPOINT" "FUNCTION" "GRAPHQL" "PUSH" "schema" "service" "sync" "trigger" "trigger_error_Handler" |
log_statuses 필수 | 의 배열 strings (LogStatus) 항목 열거형: "ERROR" "success" |
필수 | 객체 (LogForwardingPolicy) |
필수 | 객체 (LogForwardingAction) |
{- "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"
}
}
{- "_id": "string",
- "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"
}
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
forwarderId 필수 | 문자열 로그 전달자의 _id ObjectID입니다. |
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
forwarderId 필수 | 문자열 로그 전달자의 _id ObjectID입니다. |
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
forwarderId 필수 | 문자열 로그 전달자의 _id ObjectID입니다. |
계산 시간, 데이터 전송, 동기화 시간(분), 성공한 요청, 실패한 요청 등 다양한 지표를 조회합니다. 사용 가능한 지표의 전체 목록은 App Services 지표 참조를 참조하세요.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
시작하기 필수 | 문자열 쿼리 기간이 시작되는 ISO-8601 날짜 및 시간입니다(예: "2022-10-27T14:01:01Z"). |
end 필수 | 문자열 쿼리 기간이 종료되는 ISO-8601 날짜 및 시간입니다(예: "2022-12-27T14:01:01Z"). |
세분성 필수 | 문자열 쿼리 기간의 세분성을 ISO-8601 기간 값으로 지정합니다. 예시로는 "P31D"(31일), "PT1H"(1시간), "PT5M"(5분) 등이 있습니다. |
지표 | 문자열 열거형: "ACTIVE_OPEN_SYNC_SESSIONS" "AUTH_EGRESS_BYTES" "AUTH_FAILED_REQUESTS" "AUTH_RESPONSE_MS" "AUTH_SUCCESSFUL_LOGIN" "AUTH_SUCCESSFUL_REQUESTS" "AUTH_TOTAL_USERS" "ENDPOINTS_COMPUTE_MS" "ENDPOINTS_EGRESS_BYTES" "ENDPOINTS_FAILED_REQUEST" "ENDPOINTS_RESPONSE_MS" "ENDPOINTS_SUCCESSFUL_REQUESTS" "GRAPHQL_RESPONSE_MS" "GRAPHQL_COMPUTE_MS" "GRAPHQL_EGRESS_BYTES" "GRAPHQL_FAILED_REQUESTS" "GRAPHQL_SUCCESSFUL_REQUESTS" "LF_RESPONSE_MS" "OVERALL_COMPUTE_MS" "OVERALL_EGRESS_BYTES" "OVERALL_FAILED_REQUESTS" "OVERALL_SUCCESSFUL_REQUESTS" "OVERALL_SYNC_MINUTES" "SDK_COMPUTE_MS" "SDK_EGRESS_BYTES" "SDK_FAILED_REQUESTS" "SDK_FNS_RESPONSE_MS" "SDK_MQL_COMPUTE_MS" "SDK_MQL_EGRESS_BYTES" "SDK_MQL_FAILED_REQUESTS" "SDK_MQL_RESPONSE_MS" "SDK_MQL_SUCCESSFUL_REQUESTS" "SDK_SUCCESSFUL_REQUESTS" "SYNC_CLIENT_BOOTSTRAP_MS" "SYNC_CLIENT_UPLOADS_INVALID" "SYNC_CURRENT_OPLOG_LAG_MS_SUM" "SYNC_EGRESS_BYTES" "SYNC_FAILED_REQUESTS" "SYNC_HISTORY_WRITE_MS" "SYNC_MINUTES" "SYNC_NUM_INTEGRATION_ATTEMPTS" "SYNC_NUM_UNSYNCABLE_DOC" "SYNC_OT_MS" "SYNC_SESSIONS_ENDED" "SYNC_SESSIONS_STARTED" "SYNC_SUCCESSFUL_REQUESTS" "SYNC_UPLOAD_PROPS_MS" "TRIGGERS_COMPUTE_MS" "TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" "TRIGGERS_EGRESS_BYTES" "TRIGGERS_FAILED_REQUESTS" "TRIGGERS_RESPONSE_MS" "TRIGGERS_SUCCESSFUL_REQUESTS" 필터링할 지표의 이름입니다. 사용 가능한 지표 및 해당 단위에 대한 자세한 내용은 App Services 지표 참조를 확인하세요. |
{- "measurements": [
- {
- "data_points": [
- {
- "timestamp": "string",
- "value": 0
}
], - "name": "string",
- "units": "string"
}
], - "app_id": "string",
- "app_name": "string",
- "group_id": "string",
- "start": "2022-10-27T14:01:01Z",
- "end": "2022-12-27T14:01:01Z",
- "granularity": "string"
}
애플리케이션의 데이터 액세스 규칙을 보고 관리합니다.
모든 데이터 액세스 규칙을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
[- {
- "database": "string",
- "collection": "string",
- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}
]
데이터 액세스 규칙을 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
생성할 규칙입니다.
_id | 문자열 규칙의 고유 ObjectId 식별자입니다. |
의 배열 객체 (Role) 데이터 액세스 역할 목록입니다. | |
의 배열 객체 (필터) 수신 작업에 대한 필터 목록입니다. | |
database 필수 | 문자열 연결된 데이터 소스에 있는 데이터베이스의 이름입니다. |
컬렉션 필수 | 문자열 지정된 |
{- "_id": "string",
- "roles": [
- {
- "_id": "string",
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": null
}, - "property2": {
- "read": { },
- "write": { },
- "fields": null
}
}
}, - "property2": {
- "read": { },
- "write": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": null
}, - "property2": {
- "read": { },
- "write": { },
- "fields": null
}
}
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "_id": "string",
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
], - "database": "string",
- "collection": "string"
}
{- "_id": "string",
- "name": "string"
}
특정 데이터 액세스 규칙을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
ruleId 필수 | 문자열 규칙의 고유한 |
{- "_id": "string",
- "roles": [
- {
- "_id": "string",
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": null
}, - "property2": {
- "read": { },
- "write": { },
- "fields": null
}
}
}, - "property2": {
- "read": { },
- "write": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": null
}, - "property2": {
- "read": { },
- "write": { },
- "fields": null
}
}
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "_id": "string",
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
], - "database": "string",
- "collection": "string"
}
데이터 액세스 규칙을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
ruleId 필수 | 문자열 규칙의 고유한 |
데이터 액세스 규칙을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
ruleId 필수 | 문자열 규칙의 고유한 |
규칙의 새로운 상태입니다.
_id | 문자열 규칙의 고유 ObjectId 식별자입니다. |
의 배열 객체 (Role) 데이터 액세스 역할 목록입니다. | |
의 배열 객체 (필터) 수신 작업에 대한 필터 목록입니다. | |
database 필수 | 문자열 연결된 데이터 소스에 있는 데이터베이스의 이름입니다. |
컬렉션 필수 | 문자열 지정된 |
{- "_id": "string",
- "roles": [
- {
- "_id": "string",
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": null
}, - "property2": {
- "read": { },
- "write": { },
- "fields": null
}
}
}, - "property2": {
- "read": { },
- "write": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": null
}, - "property2": {
- "read": { },
- "write": { },
- "fields": null
}
}
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "_id": "string",
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
], - "database": "string",
- "collection": "string"
}
현재 기본 역할 및 필터를 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
{- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}
데이터 소스에 대한 기본 역할 및 필터를 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
기본 규칙 구성 객체입니다.
의 배열 객체 (RoleConstructor) 기본 사용자 역할의 정렬된 목록입니다. | |
의 배열 객체 (FilterConstructor) 기본 쿼리 필터 목록입니다. |
{- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}
{- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}
데이터 소스의 기본 역할 및 필터를 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
업데이트된 기본 규칙 구성 객체입니다.
_id 필수 | 문자열 기본 규칙의 고유 ObjectId 식별자입니다. |
의 배열 객체 (Role) 기본 사용자 역할의 정렬된 목록입니다. | |
의 배열 객체 (필터) 기본 쿼리 필터 목록입니다. |
{- "roles": [
- {
- "document_filters": {
- "read": { },
- "write": { }
}, - "name": "string",
- "apply_when": { },
- "read": { },
- "write": { },
- "insert": { },
- "delete": { },
- "search": { },
- "fields": {
- "property1": {
- "read": { },
- "write": { },
- "fields": { }
}, - "property2": {
- "read": { },
- "write": { },
- "fields": { }
}
}, - "additional_fields": {
- "read": { },
- "write": { }
}
}
], - "filters": [
- {
- "name": "string",
- "apply_when": { },
- "query": { },
- "projection": {
- "property1": 0,
- "property2": 0
}
}
]
}
{- "error": "default rule does not exist"
}
데이터 소스의 기본 역할 및 필터를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
{- "error": "default rule does not exist for app service"
}
애플리케이션의 스키마를 보고 관리합니다.
컬렉션의 문서 하위 집합을 쿼리하고 스키마와 비교하여 각 일치 항목의 유효성을 검사합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
datasourceId 필수 | 문자열 MongoDB 데이터 소스의 고유한 |
database_name 필수 | 문자열 유효성을 검사할 컬렉션이 포함된 데이터베이스의 이름입니다. |
collection_name 필수 | 문자열 유효성을 검사할 컬렉션의 이름입니다. |
from_schema 필수 | 객체 샘플링된 문서의 유효성을 검사하기 위한 EJSON 스키마입니다. |
쿼리 | 객체 기본값입니다: {} 컬렉션의 문서와 일치하는 MongoDB 쿼리입니다. 이 쿼리를 실행한 결과는 샘플 모집단입니다. 이를 사용하여 컬렉션에 있는 문서의 하위 집합으로 샘플 범위를 좁힙니다. |
limit | 숫자 기본값입니다: 10000 샘플링할 최대 문서 수입니다. |
sort |
{- "database_name": "string",
- "collection_name": "string",
- "from_schema": { },
- "query": { },
- "limit": 10000,
- "sort": { }
}
{- "errors": [
- {
- "error_code": "false",
- "error_count": 0,
- "field": "(root)._id",
- "failed_ids": [
- "string"
], - "failed_documents_query": { }
}
], - "total_processed_count": 0,
- "total_error_count": 0
}
정의된 모든 스키마를 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "metadata": {
- "data_source": "string",
- "database": "string",
- "collection": "string"
}
}
]
연결된 컬렉션에 대한 새 스키마를 정의합니다. 이 엔드포인트로 스키마를 생성할 때 JSON 페이로드가 완전히 이스케이프되지 않았는지 확인합니다. 잘못 이스케이프된 JSON 형식으로 인해 오류가 발생할 수 있습니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
필수 | 객체 (SchemaMetadata) 메타데이터는 스키마가 적용되는 연결된 컬렉션을 설명합니다. |
객체 (SchemaDefinition) 컬렉션의 유효한 스키마입니다. | |
객체 (SchemaRelationships) 외부 컬렉션과의 관계입니다. 각 필드 이름은 스키마의 속성입니다. 해당 값은 해당 필드에 대한 관계 정의입니다. |
{- "metadata": {
- "data_source": "string",
- "database": "string",
- "collection": "string"
}, - "schema": {
- "bsonType": "object",
- "title": "string",
- "required": [
- "string"
], - "properties": {
- "property1": { },
- "property2": { }
}
}, - "relationships": {
- "property1": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}, - "property2": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}
}
}
{- "_id": "string",
- "metadata": {
- "data_source": "string",
- "database": "string",
- "collection": "string"
}
}
_id
값으로 특정 스키마를 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
schemaId 필수 | 문자열 스키마의 고유한 |
{- "metadata": {
- "data_source": "string",
- "database": "string",
- "collection": "string"
}, - "schema": {
- "bsonType": "object",
- "title": "string",
- "required": [
- "string"
], - "properties": {
- "property1": { },
- "property2": { }
}
}, - "relationships": {
- "property1": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}, - "property2": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}
}
}
기존 스키마를 새 스키마로 바꿉니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
schemaId 필수 | 문자열 스키마의 고유한 |
객체 (SchemaMetadata) 메타데이터는 스키마가 적용되는 연결된 컬렉션을 설명합니다. | |
객체 (SchemaDefinition) 컬렉션의 유효한 스키마입니다. | |
객체 (SchemaRelationships) 외부 컬렉션과의 관계입니다. 각 필드 이름은 스키마의 속성입니다. 해당 값은 해당 필드에 대한 관계 정의입니다. |
{- "metadata": {
- "data_source": "string",
- "database": "string",
- "collection": "string"
}, - "schema": {
- "bsonType": "object",
- "title": "string",
- "required": [
- "string"
], - "properties": {
- "property1": { },
- "property2": { }
}
}, - "relationships": {
- "property1": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}, - "property2": {
- "ref": "string",
- "foreign_key": "string",
- "is_list": true
}
}
}
_id
값으로 특정 스키마를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
schemaId 필수 | 문자열 스키마의 고유한 |
null 유형 스키마 유효성 검사가 활성화되어 있는지 확인합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "enabled": true
}
null 유형 스키마 유효성 검사를 활성화하거나 비활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
활성화됨 | 부울 |
{- "enabled": true
}
애플리케이션의 시크릿을 보고 관리합니다.
Atlas App Services 앱과 연결된 시크릿을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "name": "string"
}
]
새 시크릿을 생성합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 시크릿입니다.
이름 필수 | 문자열 |
value 필수 | 문자열 |
{- "name": "string",
- "value": "string"
}
{- "_id": "string",
- "name": "string"
}
Atlas App Services 앱과 연결된 시크릿을 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
secretId 필수 | 문자열 시크릿의 고유한 |
시크릿의 수정된 값입니다.
_id | 문자열 |
이름 필수 | 문자열 |
value 필수 | 문자열 |
{- "_id": "string",
- "name": "string",
- "value": "string"
}
Atlas App Services 앱과 연결된 시크릿을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
secretId 필수 | 문자열 시크릿의 고유한 |
애플리케이션의 보안을 구성합니다.
App Services가 요청을 허용해야 하는 허용된 HTTP 출처를 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- "string"
]
App Services가 요청을 허용해야 하는 허용된 HTTP 출처를 설정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
HTTP 출처 목록입니다.
HTTP 출처입니다. <scheme>://<host>[:port]
형식이어야 합니다.
[- "string"
]
Atlas App Services 앱의 액세스 목록에 허용된 항목을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "current_ip": "string",
- "allowed_ips": [
- {
- "_id": "string",
- "address": "string",
- "ip": "string",
- "network": "string",
- "comment": "string"
}
]
}
]
App Services 앱의 액세스 목록에서 IP 주소 또는 CIDR 블록을 생성합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 IP 액세스 목록 항목입니다.
주소 필수 | 문자열 IP 주소 또는 CIDR 블록의 값입니다. |
comment | 문자열 액세스 목록 항목에 포함된 선택적 코멘트입니다. |
{- "address": "string",
- "comment": "string"
}
{- "_id": "string",
- "address": "string",
- "ip": "string",
- "network": "string",
- "comment": "string"
}
App Services 앱의 액세스 목록에서 IP 주소 또는 CIDR 블록을 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
ipId 필수 | 문자열 요청 본문에 제공된 정보와 함께 |
IP 액세스 목록 항목의 업데이트된 값입니다.
주소 필수 | 문자열 IP 주소 또는 CIDR 블록의 수정된 값입니다. |
comment | 문자열 액세스 목록 항목에 포함된 선택적 코멘트입니다. |
{- "address": "string",
- "comment": "string"
}
{- "_id": "string",
- "address": "string",
- "ip": "string",
- "network": "string",
- "comment": "string"
}
App Services 앱의 액세스 목록에서 IP 주소 또는 CIDR 블록을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
ipId 필수 | 문자열 요청 본문에 제공된 정보와 함께 |
앱에 대해 구성된 모든 비공개 엔드포인트의 목록을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "cloud_provider_region": "aws-us-east-1",
- "cloud_provider_endpoint_id": "vpce-12345678",
- "comment": "string",
- "endpoint_type": "sync"
}
]
앱에 대한 새 비공개 엔드포인트를 구성합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
cloud_provider_region 필수 | 문자열 비공개 엔드포인트를 호스팅하는 클라우드 공급자 리전입니다. |
cloud_provider_endpoint_id 필수 | 문자열 클라우드 공급자의 비공개 엔드포인트 ID입니다. |
comment | 문자열 엔드포인트를 설명하는 선택적 코멘트입니다. |
endpoint_type 필수 | 문자열 열거형: "sync" "general" 엔드포인트의 유형입니다. 엔드포인트 유형과 더 이상 사용되지 않는 엔드포인트를 |
{- "cloud_provider_region": "aws-us-east-1",
- "cloud_provider_endpoint_id": "vpce-12345678",
- "comment": "string",
- "endpoint_type": "sync"
}
{- "_id": "string",
- "cloud_provider_region": "aws-us-east-1",
- "cloud_provider_endpoint_id": "vpce-12345678",
- "comment": "string",
- "endpoint_type": "sync"
}
특정 비공개 엔드포인트 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
privateEndpointId 필수 | 문자열 VPC 비공개 엔드포인트의 _id ObjectID입니다. |
{- "_id": "string",
- "cloud_provider_region": "aws-us-east-1",
- "cloud_provider_endpoint_id": "vpce-12345678",
- "comment": "string",
- "endpoint_type": "sync"
}
비공개 엔드포인트의 구성을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
privateEndpointId 필수 | 문자열 VPC 비공개 엔드포인트의 _id ObjectID입니다. |
cloud_provider_region 필수 | 문자열 비공개 엔드포인트를 호스팅하는 클라우드 공급자 리전입니다. |
cloud_provider_endpoint_id 필수 | 문자열 클라우드 공급자의 비공개 엔드포인트 ID입니다. |
comment | 문자열 엔드포인트를 설명하는 선택적 코멘트입니다. |
endpoint_type 필수 | 문자열 열거형: "sync" "general" 엔드포인트의 유형입니다. 엔드포인트 유형과 더 이상 사용되지 않는 엔드포인트를 |
{- "cloud_provider_region": "aws-us-east-1",
- "cloud_provider_endpoint_id": "vpce-12345678",
- "comment": "string",
- "endpoint_type": "sync"
}
{- "_id": "string",
- "cloud_provider_region": "aws-us-east-1",
- "cloud_provider_endpoint_id": "vpce-12345678",
- "comment": "string",
- "endpoint_type": "sync"
}
비공개 엔드포인트를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
privateEndpointId 필수 | 문자열 VPC 비공개 엔드포인트의 _id ObjectID입니다. |
앱에 대해 구성된 모든 비공개 엔드포인트 서비스 목록을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "cloud_provider_region": "aws-us-east-1",
- "service_name": "com.amazonaws.vpce.us-east-1.vpce-svc-0f24fc6e6de007e5e",
- "endpoint_type": "sync"
}
]
비공개 엔드포인트가 활성화된 앱의 경우 앱이 VPC 외부에서 발생한 요청을 처리할지 여부를 토글합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
allow_non_vpc_client_requests | 부울 비VPC 요청을 허용하려면 |
{- "allow_non_vpc_client_requests": true
}
사용자 세션 새로 고침 토큰의 현재 만료 시간을 초 단위로 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
{- "expiration_time_seconds": 5184000
}
사용자 세션 새로 고침 토큰의 만료 시간을 초 단위로 설정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
expiration_time_seconds | 숫자 [ 1800 .. 15552000 ] 기본값입니다: 5184000 사용자 세션 새로 고침 토큰이 발급된 후 유효한 시간(초)입니다. 이 시간이 지나면 토큰은 만료되며 사용자는 다시 인증해야 합니다. 만료 시간은 30분에서 5년 사이여야 합니다. 기본 만료 시간은 60일입니다. |
{- "expiration_time_seconds": 5184000
}
애플리케이션의 데이터 소스 및 타사 서비스[사용 중단됨]를 보고 관리합니다.
이 엔드포인트를 호출하여 여러 데이터 소스를 앱에 연결합니다. 앱당 연결된 데이터 소스의 총 한도는 100 입니다. 이 엔드포인트로 연결된 데이터 소스에는 ReadAndWrite
기본 규칙이 있습니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이름 | 문자열 연결하려는 각 클러스터를 식별하는 이름을 만듭니다. |
유형 | 문자열 열거형: "mongodb-atlas" "Data Lake" 연결하려는 데이터 소스의 유형입니다. |
객체 (LinkingDataSourceConfig) |
[- {
- "name": "first-cluster",
- "type": "mongodb-atlas",
- "config": {
- "clusterName": "Cluster0"
}
}
]
{- "failedClusterNames": [
- "first-cluster"
]
}
모든 데이터 소스 및 타사 서비스[사용 중단됨]를 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "name": "string",
- "type": "string"
}
]
데이터 소스 또는 타사 서비스[사용 중단됨]를 생성합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이름 | 문자열 서비스 이름입니다. |
유형 | 문자열 서비스 유형입니다. |
객체 (AtlasClusterServiceConfigInstance) |
{- "name": "string",
- "type": "string",
- "config": {
- "clusterName": "Cluster0",
- "readPreference": "primary",
- "readPreferenceTagSets": [
- "server1"
], - "wireProtocolEnabled": true
}
}
{- "_id": "string",
- "name": "string",
- "type": "string",
- "config": {
- "clusterName": "Cluster0",
- "readPreference": "primary",
- "readPreferenceTagSets": [
- "server1"
], - "wireProtocolEnabled": true
}
}
데이터 소스 또는 타사 서비스[사용 중단됨]를 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
{- "_id": "string",
- "name": "string",
- "type": "string",
- "config": {
- "clusterName": "Cluster0",
- "readPreference": "primary",
- "readPreferenceTagSets": [
- "server1"
], - "wireProtocolEnabled": true
}
}
데이터 소스 또는 타사 서비스[사용 중단됨]를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
서비스를 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
서비스와 관련된 명령을 실행합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
commandName 필수 | 문자열 명령 이름 |
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
{- "version": "string",
- "gitVersion": "string",
- "versionArray": [
- 0
], - "javascriptEngine": "string",
- "bits": "string",
- "debug": true,
- "maxBsonObjectSize": 0
}
모든 데이터 소스 및 타사 서비스[사용 중단됨]의 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
[- {
- "name": "string",
- "type": "string"
}
]
데이터 소스 또는 타사 서비스[더 이상 사용되지 않음] 구성을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
clusterName 필수 | 문자열 내부 데이터 소스의 클러스터 이름입니다. 이름은 최대 64자 이하여야 하며, ASCII 문자, 숫자, 밑줄 및 하이픈만 포함할 수 있습니다. |
읽기 설정 필수 | 문자열 열거형: "primary" "primaryPreferred" "secondary" "secondaryPreferred" "nearest" 데이터 소스에 대한 읽기 요청의 읽기 설정 모드입니다. |
readPreferenceTagSets | 의 배열 strings (ReadPreferencesTagSet) 항목 열거형: "server1" "server2" 복제본 세트의 특정 노드를 대상으로 읽기 작업을 수행합니다. |
wireProtocolEnabled 필수 | 부울 참인 경우 클라이언트는 MongoDB 유선 프로토콜을 통해 앱에 연결할 수 있습니다. |
clusterId | 숫자 서비스 ID입니다. |
groupName | 문자열 서비스가 포함된 그룹의 이름입니다. |
orgName | 문자열 서비스가 포함된 조직의 이름입니다. |
{- "clusterName": "Cluster0",
- "readPreference": "primary",
- "readPreferenceTagSets": [
- "server1"
], - "wireProtocolEnabled": true,
- "clusterId": "05e821b3975d271289f372e3a",
- "groupName": "Project 0",
- "orgName": "MongoDB_Org"
}
컬렉션에 있는 문서의 하위 집합을 샘플링하여 JSON schema를 생성합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
database_name 필수 | 문자열 컬렉션이 포함된 데이터베이스의 이름입니다. |
collection_name 필수 | 문자열 스키마를 샘플링하고 생성할 컬렉션의 이름입니다. |
limit 필수 | integer 샘플에 포함할 문서의 최대 개수입니다. |
{- "database_name": "string",
- "collection_name": "string",
- "limit": 0
}
{- "schema": { }
}
애플리케이션 동기화에 대한 정보를 가져옵니다.
Flexible Sync를 사용할 때 특정 Atlas App Services 앱에 대한 동기화 데이터를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
{- "clusterId": "string",
- "clusterName": "string",
- "clusterType": "atlas",
- "flexible_sync": {
- "state": "string",
- "database_name": "string",
- "queryable_fields_names": [
- "string"
], - "indexed_queryable_fields_names": [
- "string"
], - "collection_queryable_fields_names": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "permissions": { },
- "last_disabled": "string",
- "client_max_offline_days": 0,
- "is_recovery_mode_disabled": true,
- "asymmetric_tables": [
- "string"
]
}, - "groupName": "string",
- "orgName": "string",
- "readPreference": "primary",
- "wireProtocolEnabled": true
}
파티션 기반 동기화를 사용할 때 파티션 필드 데이터를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
service_id 필수 | 문자열 연결된 클러스터의 서비스 ID입니다. |
{- "service_id": "string",
- "partition_fields": [
- {
- "key": "string",
- "type": "string"
}
]
}
애플리케이션의 트리거를 보고 관리합니다.
애플리케이션의 모든 트리거 목록을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
]
애플리케이션에서 새 트리거를 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
데이터베이스, 예정 또는 인증 트리거에 대한 구성입니다.
이름 필수 | 문자열 트리거의 이름입니다. |
유형 필수 | 문자열 값: "DATABASE" 트리거 유형입니다. 데이터베이스 트리거의 경우 이 값은 항상 |
비활성화 | 부울 기본값입니다: 거짓
|
필수 | 객체 트리거에 대한 구성 값을 정의하는 객체입니다. |
function_id | 문자열 트리거가 실행될 때 호출하는 함수의 ID입니다. 이 값은 예를 들어, |
function_name | 문자열 트리거가 실행될 때 호출하는 함수의 이름입니다. 즉, 이 값은 예를 들어, |
객체 객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요. | |
객체 AWS EventBridge 트리거에 대한 사용자 지정 오류 처리를 정의하는 객체입니다. |
{- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
{- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
애플리케이션의 기존 트리거에 대한 구성을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
triggerId 필수 | 문자열 트리거의 고유한 |
{- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
애플리케이션에서 기존 트리거를 수정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
triggerId 필수 | 문자열 트리거의 고유한 |
업데이트된 트리거 구성입니다.
이름 필수 | 문자열 트리거의 이름입니다. |
유형 필수 | 문자열 값: "DATABASE" 트리거 유형입니다. 데이터베이스 트리거의 경우 이 값은 항상 |
비활성화 | 부울 기본값입니다: 거짓
|
필수 | 객체 트리거에 대한 구성 값을 정의하는 객체입니다. |
function_id | 문자열 트리거가 실행될 때 호출하는 함수의 ID입니다. 이 값은 예를 들어, |
function_name | 문자열 트리거가 실행될 때 호출하는 함수의 이름입니다. 즉, 이 값은 예를 들어, |
객체 객체의 각 필드 이름이 이벤트 프로세서 ID이고 각 값이 해당 이벤트 프로세서를 구성하는 객체입니다. 구성 객체 예시는 AWS EventBridge에 트리거 이벤트 전송을 참조하세요. | |
객체 AWS EventBridge 트리거에 대한 사용자 지정 오류 처리를 정의하는 객체입니다. | |
_id | 문자열 트리거의 고유 ID입니다. |
{- "name": "onNewEmployee",
- "type": "DATABASE",
- "function_id": "5eea9ca4ca0e356e2c2a148a",
- "config": {
- "operation_types": [
- "INSERT"
], - "database": "HR",
- "collection": "employees",
- "service_id": "5adeb649b8b998486770ae7c",
- "match": { },
- "project": { },
- "full_document": true
}
}
{- "error": "string",
- "error_code": "string"
}
애플리케이션에서 기존 트리거를 제거합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
triggerId 필수 | 문자열 트리거의 고유한 |
{ }
일시중단된 데이터베이스 트리거를 재개합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
triggerId 필수 | 문자열 트리거의 고유한 |
작업 재개를 위한 구성 옵션입니다.
disable_token | 부울
|
{- "disable_token": true
}
{- "error": "string"
}
애플리케이션 사용자를 보고 관리합니다.
확인된 사용자 계정을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이후 | 문자열 이전에 페이지 매김 요청에 의해 반환된 마지막 사용자의 |
sort | 문자열 결과를 정렬할 필드 이름입니다. 유효한 값은 기본값인 |
desc | 부울
|
[- {
- "_id": "string",
- "identities": [
- {
- "id": "string",
- "provider_type": "anon-user",
- "provider_id": "string"
}
], - "type": "normal",
- "creation_date": 0,
- "last_authentication_date": 0,
- "disabled": true,
- "data": { }
}
]
새 이메일/비밀번호 사용자 계정을 만듭니다.
참고: 이메일/비밀번호 이외의 인증 제공자에 대해서는 관리자 API를 통해 사용자 계정을 생성할 수 없습니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 사용자
이메일 필수 | 문자열 |
비밀번호 필수 | 문자열 |
{- "email": "string",
- "password": "string"
}
{- "_id": "string",
- "identities": [
- {
- "id": "string",
- "provider_type": "anon-user",
- "provider_id": "string"
}
], - "type": "normal",
- "creation_date": 0,
- "last_authentication_date": 0,
- "disabled": true,
- "data": { }
}
사용자의 클라이언트 액세스 토큰이 유효한지 확인합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
사용자의 클라이언트 액세스 토큰입니다. 액세스 토큰은 로그인한 애플리케이션 사용자를 나타냅니다. 이것은 관리자 API로 작업하는 데 사용하는 access_token
과 동일하지 않습니다.
token 필수 | 문자열 |
{- "token": "string"
}
"token expired"
ID별로 특정 사용자 계정을 가져옵니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
{- "_id": "string",
- "identities": [
- {
- "id": "string",
- "provider_type": "anon-user",
- "provider_id": "string"
}
], - "type": "normal",
- "creation_date": 0,
- "last_authentication_date": 0,
- "disabled": true,
- "data": { }
}
ID로 특정 사용자 계정을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
ID별로 이메일/비밀번호 사용자의 이메일 주소를 변경합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
사용자의 새 이메일 주소입니다.
이메일 필수 | 문자열 사용자의 새 이메일입니다. |
{- "email": "new_email@example.com"
}
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
[- { }
]
사용자의 모든 세션을 취소합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
사용자를 활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
사용자를 비활성화합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
userId 필수 | 문자열 사용자 계정 ID |
대기 중인 사용자 계정 등록을 나열합니다. 호출에서 대기 중인 사용자를 최대 50명까지 반환합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이후 | 문자열 대기 중인 사용자의 고유한 |
[- {
- "_id": "63754f968a605a78ea6939e7",
- "domain_id": "60c8f69864c0a72d14bb534c",
- "login_ids": [
- {
- "id_type": "email",
- "id": "someone@example.com"
}
], - "user_id": ""
}, - {
- "_id": "63754fd83c001970b1e5ea66",
- "domain_id": "60c8f69864c0a73e3e11c22b",
- "login_ids": [
- {
- "id_type": "email",
- "id": "joe@example.com"
}
], - "user_id": ""
}
]
대기 중인 사용자를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이메일 필수 | 문자열 이메일 주소 |
확인 이메일을 보냅니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이메일 필수 | 문자열 이메일 주소 |
대기 중인 사용자를 확인합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이메일 필수 | 문자열 이메일 주소 |
대기 중인 사용자의 확인 워크플로를 다시 실행합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
이메일 필수 | 문자열 이메일 주소 |
애플리케이션의 값을 보고 관리합니다.
애플리케이션에 정의된 모든 값을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
[- {
- "_id": "string",
- "name": "string",
- "private": true
}
]
애플리케이션에서 값을 정의합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 값입니다.
이름 필수 | 문자열 |
비공개 필수 | 부울 |
value 필수 | any (AnyValue) Any valid JSON value |
{- "name": "string",
- "private": true,
- "value": null
}
{- "name": "string",
- "private": true,
- "value": null
}
애플리케이션에서 값 정의를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
valueId 필수 | 문자열 값의 고유한 |
{- "name": "string",
- "private": true,
- "from_secret": true,
- "value": null
}
애플리케이션에 정의된 값을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
valueId 필수 | 문자열 값의 고유한 |
애플리케이션에서 값 정의를 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
valueId 필수 | 문자열 값의 고유한 |
[- {
- "name": "string",
- "private": true,
- "value": null
}
]
애플리케이션의 푸시 알림을 보고 관리합니다.
푸시 알림을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
상태 | 문자열 (MessageState) 열거형: "sent" "draft" 특정 상태의 알림만 나열합니다. |
[- {
- "allowed_ips": "string",
- "appID": "string",
- "label": "string",
- "message": "string",
- "topic": "string",
- "created": "string",
- "sent": "string",
- "state": "sent"
}
]
푸시 알림을 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
생성할 알림입니다.
레이블 필수 | 문자열 |
메시지 필수 | 문자열 |
주제 필수 | 문자열 |
상태 필수 | 문자열 (MessageState) 열거형: "sent" "draft" |
{- "label": "string",
- "message": "string",
- "topic": "string",
- "state": "sent"
}
푸시 알림 메시지를 조회합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
messageId 필수 | 문자열 메시지 ID |
{- "allowed_ips": "string",
- "appID": "string",
- "label": "string",
- "message": "string",
- "topic": "string",
- "created": "string",
- "sent": "string",
- "state": "sent"
}
푸시 알림 메시지를 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
messageId 필수 | 문자열 메시지 ID |
푸시 알림 메시지를 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
messageId 필수 | 문자열 메시지 ID |
{- "allowed_ips": "string",
- "appID": "string",
- "label": "string",
- "message": "string",
- "topic": "string",
- "created": "string",
- "sent": "string",
- "state": "sent"
}
푸시 알림 유형을 설정합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
messageId 필수 | 문자열 메시지 ID |
푸시 알림을 보냅니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
messageId 필수 | 문자열 메시지 ID |
애플리케이션의 웹훅을 보고 관리합니다.
웹훅을 나열합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
{- "name": "string",
- "function_source": "string",
- "respond_result": true,
- "options": {
- "secret": "string",
- "secretAsQueryParam": true
}
}
웹훅을 만듭니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
생성할 웹훅입니다.
이름 필수 | 문자열 |
function_source 필수 | 문자열 |
respond_result 필수 | 부울 |
객체 |
{- "name": "string",
- "function_source": "string",
- "respond_result": true,
- "options": {
- "secret": "string",
- "secretAsQueryParam": true
}
}
Retrieve a webhook.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
incomingWebhookId 필수 | 문자열 수신 웹훅의 고유한 |
웹훅을 삭제합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
incomingWebhookId 필수 | 문자열 수신 웹훅의 고유한 |
웹훅 을 업데이트합니다.
groupId 필수 | 문자열 Atlas 프로젝트/그룹 ID입니다. |
appId 필수 | 문자열 애플리케이션의 ObjectID입니다. App Services API 프로젝트 및 애플리케이션 ID 섹션은 이 값을 찾는 방법을 보여줍니다. |
serviceId 필수 | 문자열 서비스의 고유한 |
incomingWebhookId 필수 | 문자열 수신 웹훅의 고유한 |
웹훅의 업데이트된 상태입니다.
이름 필수 | 문자열 |
function_source 필수 | 문자열 |
respond_result 필수 | 부울 |
객체 |
{- "name": "string",
- "function_source": "string",
- "respond_result": true,
- "options": {
- "secret": "string",
- "secretAsQueryParam": true
}
}