Notebooks API

Notebooks API를 사용하면 Google Cloud에서 에이전트 플랫폼 워크벤치 리소스를 관리할 수 있습니다.

서비스: notebooks.googleapis.com

이 서비스를 호출하려면 Google에서 제공하는 클라이언트 라이브러리를 사용하는 것이 좋습니다. 애플리케이션에서 자체 라이브러리를 사용하여 이 서비스를 호출해야 한다면 API 요청을 실행할 때 다음 정보를 사용해야 합니다.

검색 문서

탐색 문서는 머신에서 읽을 수 있는 사양이며 REST API를 설명하고 사용하는 데 참고할 수 있습니다. 또한 클라이언트 라이브러리, IDE 플러그인, 기타 Google API와 상호작용하는 도구를 빌드하는 데 사용됩니다. 하나의 서비스는 여러 개의 탐색 문서를 제공할 수 있습니다. 이 서비스는 다음 검색 문서를 제공합니다.

서비스 엔드포인트

서비스 엔드포인트는 API 서비스의 네트워크 주소를 지정하는 기준 URL입니다. 하나의 서비스는 여러 서비스 엔드포인트를 포함할 수 있습니다. 이 서비스에는 다음 서비스 엔드포인트가 포함되고, 그 아래의 모든 URI가 이 서비스 엔드포인트와 관련됩니다.

  • https://notebooks.googleapis.com

REST 리소스: v2.projects.locations

방법
get GET /v2/{name}
위치 정보를 가져옵니다.
list GET /v2/{name}/locations
이 서비스에 지원되는 위치 정보를 나열합니다.

REST 리소스: v2.projects.locations.instances

메서드
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
노트북 인스턴스를 업그레이드할 수 있는지 확인합니다.
create POST /v2/{parent}/instances
특정 프로젝트 및 위치에 새 인스턴스를 만듭니다.
delete DELETE /v2/{name}
단일 인스턴스를 삭제합니다.
diagnose POST /v2/{name}:diagnose
인스턴스가 주어지면 진단 파일을 만들고 진단 도구를 실행합니다.
get GET /v2/{name}
단일 인스턴스의 세부정보를 가져옵니다.
getConfig GET /v2/{name}/instances:getConfig
다양한 구성 매개변수를 반환합니다.
getIamPolicy GET /v2/{resource}:getIamPolicy
리소스의 액세스 제어 정책을 가져옵니다.
list GET /v2/{parent}/instances
특정 프로젝트 및 위치의 인스턴스를 나열합니다.
patch PATCH /v2/{instance.name}
UpdateInstance는 인스턴스를 업데이트합니다.
reset POST /v2/{name}:reset
노트북 인스턴스를 재설정합니다.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
노트북 인스턴스 디스크의 크기를 더 큰 용량으로 조정합니다.
restore POST /v2/{name}:restore
RestoreInstance는 BackupSource에서 인스턴스를 복원합니다.
rollback POST /v2/{name}:rollback
노트북 인스턴스를 이전 버전으로 롤백합니다.
setIamPolicy POST /v2/{resource}:setIamPolicy
지정된 리소스의 액세스 제어 정책을 설정합니다.
start POST /v2/{name}:start
노트북 인스턴스를 시작합니다.
stop POST /v2/{name}:stop
메모장 인스턴스를 중지합니다.
testIamPermissions POST /v2/{resource}:testIamPermissions
지정된 리소스에 대해 호출자가 보유한 권한을 반환합니다.
upgrade POST /v2/{name}:upgrade
노트북 인스턴스를 최신 버전으로 업그레이드합니다.

REST 리소스: v2.projects.locations.operations

방법
cancel POST /v2/{name}:cancel
장기 실행 작업에 대한 비동기 취소를 시작합니다.
delete DELETE /v2/{name}
장기 실행 작업을 삭제합니다.
get GET /v2/{name}
장기 실행 작업의 최신 상태를 가져옵니다.
list GET /v2/{name}/operations
요청에 지정된 필터와 일치하는 작업을 나열합니다.

REST 리소스: v1.projects.locations

메서드
get GET /v1/{name}
위치 정보를 가져옵니다.
list GET /v1/{name}/locations
이 서비스에 지원되는 위치 정보를 나열합니다.

REST 리소스: v1.projects.locations.environments

메서드
create POST /v1/{parent}/environments
새 환경을 만듭니다.
delete DELETE /v1/{name}
단일 환경을 삭제합니다.
get GET /v1/{name}
단일 환경의 세부정보를 가져옵니다.
list GET /v1/{parent}/environments
프로젝트의 환경을 나열합니다.

REST 리소스: v1.projects.locations.executions

메서드
create POST /v1/{parent}/executions
특정 프로젝트와 위치에 새 실행을 만듭니다.
delete DELETE /v1/{name}
실행을 삭제합니다.
get GET /v1/{name}
실행 세부정보를 가져옵니다.
list GET /v1/{parent}/executions
특정 프로젝트와 위치의 실행을 나열합니다.

REST 리소스: v1.projects.locations.instances

메서드
create POST /v1/{parent}/instances
특정 프로젝트 및 위치에 새 인스턴스를 만듭니다.
delete DELETE /v1/{name}
단일 인스턴스를 삭제합니다.
diagnose POST /v1/{name}:diagnose
인스턴스가 주어지면 진단 파일을 만들고 진단 도구를 실행합니다.
get GET /v1/{name}
단일 인스턴스의 세부정보를 가져옵니다.
getIamPolicy GET /v1/{resource}:getIamPolicy
리소스의 액세스 제어 정책을 가져옵니다.
getInstanceHealth GET /v1/{name}:getInstanceHealth
노트북 인스턴스가 정상인지 확인합니다.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
노트북 인스턴스를 업그레이드할 수 있는지 확인합니다.
list GET /v1/{parent}/instances
특정 프로젝트 및 위치의 인스턴스를 나열합니다.
migrate POST /v1/{name}:migrate
기존 사용자 관리 노트북을 Workbench 인스턴스로 마이그레이션합니다.
register POST /v1/{parent}/instances:register
기존 기존 노트북 인스턴스를 Notebooks API 서버에 등록합니다.
report POST /v1/{name}:report
노트북 인스턴스가 최신 인스턴스 정보를 Notebooks API 서버에 보고하도록 허용합니다.
reset POST /v1/{name}:reset
노트북 인스턴스를 재설정합니다.
rollback POST /v1/{name}:rollback
노트북 인스턴스를 이전 버전으로 롤백합니다.
setAccelerator PATCH /v1/{name}:setAccelerator
단일 인스턴스의 게스트 액셀러레이터를 업데이트합니다.
setIamPolicy POST /v1/{resource}:setIamPolicy
지정된 리소스의 액세스 제어 정책을 설정합니다.
setLabels PATCH /v1/{name}:setLabels
인스턴스의 모든 라벨을 대체합니다.
setMachineType PATCH /v1/{name}:setMachineType
단일 인스턴스의 머신 유형을 업데이트합니다.
start POST /v1/{name}:start
노트북 인스턴스를 시작합니다.
stop POST /v1/{name}:stop
메모장 인스턴스를 중지합니다.
testIamPermissions POST /v1/{resource}:testIamPermissions
지정된 리소스에 대해 호출자가 보유한 권한을 반환합니다.
updateConfig PATCH /v1/{name}:updateConfig
노트북 인스턴스 구성을 업데이트합니다.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
인스턴스의 메타데이터 항목을 추가/업데이트합니다.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
단일 인스턴스의 보안 인스턴스 구성을 업데이트합니다.
upgrade POST /v1/{name}:upgrade
노트북 인스턴스를 최신 버전으로 업그레이드합니다.

REST 리소스: v1.projects.locations.operations

메서드
cancel POST /v1/{name}:cancel
장기 실행 작업에 대한 비동기 취소를 시작합니다.
delete DELETE /v1/{name}
장기 실행 작업을 삭제합니다.
get GET /v1/{name}
장기 실행 작업의 최신 상태를 가져옵니다.
list GET /v1/{name}/operations
요청에 지정된 필터와 일치하는 작업을 나열합니다.

REST 리소스: v1.projects.locations.runtimes

메서드
create POST /v1/{parent}/runtimes
특정 프로젝트와 위치에 새 런타임을 만듭니다.
delete DELETE /v1/{name}
단일 런타임을 삭제합니다.
get GET /v1/{name}
단일 런타임의 세부정보를 가져옵니다.
getIamPolicy GET /v1/{resource}:getIamPolicy
리소스의 액세스 제어 정책을 가져옵니다.
list GET /v1/{parent}/runtimes
특정 프로젝트와 위치의 런타임을 나열합니다.
migrate POST /v1/{name}:migrate
기존 런타임을 새 Workbench 인스턴스로 마이그레이션합니다.
patch PATCH /v1/{runtime.name}
노트북 런타임 구성을 업데이트합니다.
reportEvent POST /v1/{name}:reportEvent
런타임 이벤트를 보고하고 처리합니다.
reset POST /v1/{name}:reset
관리형 노트북 런타임을 재설정합니다.
setIamPolicy POST /v1/{resource}:setIamPolicy
지정된 리소스의 액세스 제어 정책을 설정합니다.
start POST /v1/{name}:start
관리형 노트북 런타임을 시작합니다.
stop POST /v1/{name}:stop
관리형 노트북 런타임을 중지합니다.
switch POST /v1/{name}:switch
관리형 노트북 런타임을 전환합니다.
testIamPermissions POST /v1/{resource}:testIamPermissions
지정된 리소스에 대해 호출자가 보유한 권한을 반환합니다.

REST 리소스: v1.projects.locations.schedules

메서드
create POST /v1/{parent}/schedules
특정 프로젝트와 위치에 새 예약된 노트북을 만듭니다.
delete DELETE /v1/{name}
일정과 모든 기본 작업을 삭제합니다.
get GET /v1/{name}
일정 세부정보를 가져옵니다.
list GET /v1/{parent}/schedules
특정 프로젝트와 위치의 일정을 나열합니다.