Method: projects.databases.exportDocuments

Google Cloud Firestore의 문서 전체 또는 하위 집합을 Google Cloud Storage와 같은 다른 스토리지 시스템으로 내보냅니다. 문서의 최근 업데이트가 내보내기에 반영되지 않을 수 있습니다. 내보내기는 백그라운드에서 실행되며 생성된 작업 리소스를 통해 진행 상황을 모니터링하고 관리할 수 있습니다. 내보내기의 출력은 연결된 작업이 완료된 후에만 사용할 수 있습니다. 내보내기 작업이 완료 전에 취소되면 Google Cloud Storage에 일부 데이터가 남을 수 있습니다.

내보내기 동작 및 출력 형식에 대한 자세한 내용은 https://cloud.google.com/firestore/docs/manage-data/export-import를 참조하세요.

HTTP 요청

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:exportDocuments

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. 내보낼 데이터베이스입니다. projects/{projectId}/databases/{databaseId} 형식이어야 합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string,
  "namespaceIds": [
    string
  ],
  "snapshotTime": string
}
입력란
collectionIds[]

string

내보낼 컬렉션 ID입니다. 지정되지 않음은 모든 컬렉션을 의미합니다.
outputUriPrefix

string

출력 URI입니다. 현재 gs://BUCKET_NAME[/NAMESPACE_PATH] 형식의 Google Cloud Storage URI만 지원합니다. 여기서 BUCKET_NAME은 Google Cloud Storage 버킷의 이름이고 NAMESPACE_PATH는 선택사항인 Google Cloud Storage 네임스페이스 경로입니다. 이름을 선택할 때 Google Cloud Storage 이름 지정 가이드라인(https://cloud.google.com/storage/docs/naming)을 고려하세요. URI가 네임스페이스 경로가 없는 버킷이면 시작 시간을 기준으로 프리픽스가 생성됩니다.
namespaceIds[]

string

빈 목록은 모든 네임스페이스를 나타냅니다. 네임스페이스를 사용하지 않는 데이터베이스의 경우 선호되는 방식입니다.

빈 문자열 요소는 기본 네임스페이스를 나타냅니다. 이 옵션은 데이터베이스에 기본이 아닌 네임스페이스에 데이터가 있지만 포함하지 않으려는 경우에 사용해야 합니다. 이 목록의 각 네임스페이스는 고유해야 합니다.
snapshotTime

string (Timestamp format)

내보낼 데이터베이스의 버전에 해당하는 타임스탬프입니다. 타임스탬프는 과거여야 하며 분으로 반올림되어야 하며 earliestVersionTime 이전이어야 합니다. 지정하면 내보낸 문서가 지정된 시간에 데이터베이스의 일관된 뷰를 표시합니다. 그렇지 않으면 내보낸 문서의 일관성을 보장하지 않습니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.