Method: projects.locations.instances.list

특정 프로젝트 및 위치의 인스턴스를 나열합니다.

HTTP 요청

GET https://notebooks.googleapis.com/v2/{parent}/instances

경로 매개변수

매개변수
parent

string

필수 항목입니다. 인스턴스의 상위 요소입니다. 형식: - projects/{projectId}/locations/{location}: 특정 영역의 인스턴스를 나열합니다. - projects/{projectId}/locations/-: 모든 위치의 인스턴스를 나열합니다.

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

  • notebooks.instances.list

쿼리 파라미터

파라미터
pageSize

integer

(선택사항) 목록 호출의 최대 반환 크기입니다.
pageToken

string

(선택사항) 마지막 결과부터 목록을 계속하는 데 사용할 수 있는 이전 반환 페이지 토큰입니다.
orderBy

string

(선택사항) 결과를 정렬합니다. 지원되는 값은 'name', 'name desc' 또는 ''(정렬되지 않음)입니다.
filter

string

(선택사항) 필터를 나열합니다.

요청 본문

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

응답 본문

노트북 인스턴스 목록에 대한 응답입니다.

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

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

object (Instance)

반환된 인스턴스 목록입니다.
nextPageToken

string

다음 목록 호출에서 마지막 결과부터 목록을 계속하는 데 사용할 수 있는 페이지 토큰입니다.
unreachable[]

string

순서가 지정되지 않은 목록 도달할 수 없는 위치입니다. 예를 들어 ['projects/{projectId}/locations/us-west1-a', 'projects/{projectId}/locations/us-central1-b']입니다. ListInstancesResponse에는 인스턴스 또는 연결할 수 없는 인스턴스만 포함됩니다.

승인 범위

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

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

자세한 내용은 Authentication Overview를 참조하세요.