Method: projects.locations.instances.list

지정된 상위 프로젝트와 연결된 각 DatabaseInstance를 나열합니다.

목록 항목은 특별한 순서 없이 반환되지만 pageToken로 추가 요청이 있을 때 데이터베이스 인스턴스를 일관되게 표시합니다.

결과 목록에는 STATE의 인스턴스가 포함됩니다.

목록 결과가 몇 초 정도 비활성 상태일 수 있습니다.

일관된 읽기를 위해 instances.get를 사용합니다.

HTTP 요청

GET https://firebasedatabase.googleapis.com/v1beta/{parent=projects/*/locations/*}/instances

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

경로 매개변수

매개변수
parent

string

데이터베이스 인스턴스를 나열할 상위 프로젝트이며 형식은 projects/{project-number}/locations/{location-id}입니다.

모든 위치를 나열하려면 projects/{project-number}/locations/- 형식의 상위 요소를 사용합니다.

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • firebasedatabase.instances.list

쿼리 매개변수

매개변수
pageToken

string

데이터베이스 인스턴스 집합 내에서 목록을 다시 시작할 위치를 나타내는 instances.list에 대한 이전 호출에서 반환된 토큰입니다.
pageSize

integer

응답에서 반환할 데이터베이스 인스턴스의 최대 개수입니다.

서버는 자체 재량에 따라 이보다 더 적은 수의 앱을 반환할 수 있습니다. 값을 지정하지 않을 경우(또는 너무 큰 값을 지정할 경우), 서버는 자체 한도를 적용합니다.
showDeleted

boolean

DELETED 상태의 DatabaseInstances도 반환되어야 함을 나타냅니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

instances.list 메서드의 응답입니다.

JSON 표현 
{
  "instances": [
    {
      object (DatabaseInstance)
    }
  ],
  "nextPageToken": string
}
필드
instances[]

object (DatabaseInstance)

상위 Firebase 프로젝트에 있는 각 DatabaseInstance의 목록입니다.
nextPageToken

string

결과 목록이 너무 많아서 단일 응답에 맞지 않으면 토큰이 반환됩니다. 문자열이 비어 있다면 이 응답은 결과의 마지막 페이지에 해당됩니다.

이 토큰은 다음 데이터베이스 인스턴스 그룹을 찾기 위해 instances.list에 대한 후속 호출에서 사용할 수 있습니다.

페이지 토큰은 수명이 짧기 때문에 유지해서는 안 됩니다.

승인 범위

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

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