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 상태의 DatabaseInstance도 반환되어야 함을 나타냅니다.

요청 본문

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

응답 본문

성공하면 응답 본문에 다음 구조의 데이터가 포함됩니다.

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

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