Package google.cloud.notebooks.v1

색인

ManagedNotebookService

관리형 노트북용 API v1 서비스입니다.

CreateRuntime

rpc CreateRuntime(CreateRuntimeRequest) returns (Operation)

특정 프로젝트와 위치에 새 런타임을 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc DeleteRuntime(DeleteRuntimeRequest) returns (Operation)

단일 런타임을 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc GetRuntime(GetRuntimeRequest) returns (Runtime)

단일 런타임의 세부정보를 가져옵니다. 위치는 영역 엔드포인트가 아닌 리전 엔드포인트여야 합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

특정 프로젝트와 위치의 런타임을 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc MigrateRuntime(MigrateRuntimeRequest) returns (Operation)

기존 런타임을 새 Workbench 인스턴스로 마이그레이션합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ReportRuntimeEvent(ReportRuntimeEventRequest) returns (Operation)

런타임 이벤트를 보고하고 처리합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ResetRuntime(ResetRuntimeRequest) returns (Operation)

관리형 노트북 런타임을 재설정합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc StartRuntime(StartRuntimeRequest) returns (Operation)

관리형 노트북 런타임을 시작합니다. GPU 인스턴스에서 '시작', CPU 인스턴스에서 '재개'를 실행합니다. https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance를 참고하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc StopRuntime(StopRuntimeRequest) returns (Operation)

관리형 노트북 런타임을 중지합니다. GPU 인스턴스에서 '중지'를 실행하고 CPU 인스턴스에서 '일시중지'를 실행합니다. https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance를 참고하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc SwitchRuntime(SwitchRuntimeRequest) returns (Operation)

관리형 노트북 런타임을 전환합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc UpdateRuntime(UpdateRuntimeRequest) returns (Operation)

노트북 런타임 구성을 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

NotebookService

Cloud AI Platform Notebooks의 API v1 서비스입니다.

CreateEnvironment

rpc CreateEnvironment(CreateEnvironmentRequest) returns (Operation)

새 환경을 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc CreateExecution(CreateExecutionRequest) returns (Operation)

특정 프로젝트와 위치에 새 실행을 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

특정 프로젝트 및 위치에 새 인스턴스를 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc CreateSchedule(CreateScheduleRequest) returns (Operation)

특정 프로젝트와 위치에 새 예약 노트북을 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (Operation)

단일 환경을 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc DeleteExecution(DeleteExecutionRequest) returns (Operation)

실행을 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

단일 인스턴스를 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc DeleteSchedule(DeleteScheduleRequest) returns (Operation)

일정과 모든 기본 작업을 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc DiagnoseInstance(DiagnoseInstanceRequest) returns (Operation)

인스턴스가 주어지면 진단 파일을 만들고 진단 도구를 실행합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc GetEnvironment(GetEnvironmentRequest) returns (Environment)

단일 환경의 세부정보를 가져옵니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc GetExecution(GetExecutionRequest) returns (Execution)

실행 세부정보를 가져옵니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc GetInstance(GetInstanceRequest) returns (Instance)

단일 인스턴스의 세부정보를 가져옵니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc GetInstanceHealth(GetInstanceHealthRequest) returns (GetInstanceHealthResponse)

노트북 인스턴스가 정상인지 확인합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc GetSchedule(GetScheduleRequest) returns (Schedule)

일정의 세부정보를 가져옵니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc IsInstanceUpgradeable(IsInstanceUpgradeableRequest) returns (IsInstanceUpgradeableResponse)

노트북 인스턴스를 업그레이드할 수 있는지 확인합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse)

프로젝트의 환경을 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

특정 프로젝트 및 위치의 실행을 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

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

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse)

특정 프로젝트와 위치의 일정을 나열합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc MigrateInstance(MigrateInstanceRequest) returns (Operation)

기존 사용자 관리 노트북을 Workbench 인스턴스로 마이그레이션합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc RegisterInstance(RegisterInstanceRequest) returns (Operation)

기존 기존 노트북 인스턴스를 Notebooks API 서버에 등록합니다. 기존 인스턴스는 기존 Compute Engine 호출로 생성된 인스턴스입니다. 기본적으로 Notebooks API로 관리할 수 없습니다. 이 호출을 통해 Notebooks API에서 이러한 인스턴스를 관리할 수 있습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ReportInstanceInfo(ReportInstanceInfoRequest) returns (Operation)

노트북 인스턴스가 최신 인스턴스 정보를 Notebooks API 서버에 보고하도록 허용합니다. 서버는 보고된 정보를 인스턴스 메타데이터 스토어에 병합합니다. 이 메서드를 직접 사용하지 마세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc ResetInstance(ResetInstanceRequest) returns (Operation)

노트북 인스턴스를 재설정합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc RollbackInstance(RollbackInstanceRequest) returns (Operation)

노트북 인스턴스를 이전 버전으로 롤백합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc SetInstanceAccelerator(SetInstanceAcceleratorRequest) returns (Operation)

단일 인스턴스의 게스트 액셀러레이터를 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc SetInstanceLabels(SetInstanceLabelsRequest) returns (Operation)

인스턴스의 모든 라벨을 바꿉니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc SetInstanceMachineType(SetInstanceMachineTypeRequest) returns (Operation)

단일 인스턴스의 머신 유형을 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc StartInstance(StartInstanceRequest) returns (Operation)

노트북 인스턴스를 시작합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc StopInstance(StopInstanceRequest) returns (Operation)

메모장 인스턴스를 중지합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc UpdateInstanceConfig(UpdateInstanceConfigRequest) returns (Operation)

노트북 인스턴스 구성을 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc UpdateInstanceMetadataItems(UpdateInstanceMetadataItemsRequest) returns (UpdateInstanceMetadataItemsResponse)

인스턴스의 메타데이터 항목을 추가/업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc UpdateShieldedInstanceConfig(UpdateShieldedInstanceConfigRequest) returns (Operation)

단일 인스턴스의 보안 인스턴스 구성을 업데이트합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

rpc UpgradeInstance(UpgradeInstanceRequest) returns (Operation)

노트북 인스턴스를 최신 버전으로 업그레이드합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

ContainerImage

컨테이너에 설치된 환경으로 노트북 인스턴스를 시작하기 위한 컨테이너 이미지의 정의입니다.

필드
repository

string

필수 항목입니다. 컨테이너 이미지 저장소의 경로입니다. 예: gcr.io/{project_id}/{image_name}
tag

string

컨테이너 이미지의 태그입니다. 지정하지 않으면 기본적으로 최신 태그가 사용됩니다.

CreateEnvironmentRequest

노트북 환경 생성 요청입니다.

필드
parent

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}

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

  • notebooks.environments.create
environment_id

string

필수 항목입니다. 이 환경의 사용자 정의 고유 ID입니다. environment_id는 1~63자(영문 기준)여야 하며 소문자, 숫자, 대시만 포함해야 합니다. 첫 번째 문자는 소문자여야 하며 마지막 문자는 대시가 아니어야 합니다.
environment

Environment

필수 항목입니다. 생성할 환경입니다.

CreateExecutionRequest

노트북 실행 생성 요청

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.executions.create
execution_id

string

필수 항목입니다. 이 실행의 사용자 정의 고유 ID입니다.
execution

Execution

필수 항목입니다. 생성할 실행입니다.

CreateInstanceRequest

노트북 인스턴스 생성 요청입니다.

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.instances.create
instance_id

string

필수 항목입니다. 이 인스턴스의 사용자 정의 고유 ID입니다.
instance

Instance

필수 항목입니다. 생성할 인스턴스입니다.

CreateRuntimeRequest

관리형 노트북 런타임 생성 요청입니다.

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.runtimes.create
runtime_id

string

필수 항목입니다. 이 런타임의 사용자 정의 고유 ID입니다.
runtime

Runtime

필수 항목입니다. 생성할 런타임입니다.
request_id

string

멱등성 요청 UUID입니다.

CreateScheduleRequest

생성된 예약 노트북 요청

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.schedules.create
schedule_id

string

필수 항목입니다. 이 일정의 사용자 정의 고유 ID입니다.
schedule

Schedule

필수 항목입니다. 생성할 일정입니다.

DeleteEnvironmentRequest

노트북 환경 삭제 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/environments/{environment_id}

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

  • notebooks.environments.delete

DeleteExecutionRequest

예약된 노트북 실행 삭제 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/executions/{execution_id}

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

  • notebooks.executions.delete

DeleteInstanceRequest

노트북 인스턴스 삭제 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.delete

DeleteRuntimeRequest

관리형 노트북 런타임 삭제 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • notebooks.runtimes.delete
request_id

string

멱등성 요청 UUID입니다.

DeleteScheduleRequest

일정 삭제 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/schedules/{schedule_id}

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

  • notebooks.schedules.delete

DiagnoseInstanceRequest

노트북 인스턴스 진단 파일 생성 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}
diagnostic_config

DiagnosticConfig

필수 항목입니다. 진단 도구를 실행하는 데 사용되는 플래그를 정의합니다.
timeout_minutes

int32

선택사항입니다. 작업이 타임아웃되기 전의 최대 시간(분)입니다.

DiagnosticConfig

진단 도구를 실행하는 데 사용되는 플래그를 정의합니다.

필드
gcs_bucket

string

필수 항목입니다. 사용자 Cloud Storage 버킷 위치 (필수). 경로 접두사 (gs://$GCS_BUCKET)로 형식을 지정해야 합니다.

권한: 사용자 관리 노트북: - storage.buckets.writer: VM에 연결된 프로젝트의 서비스 계정에 부여해야 합니다. Google 관리형 노트북: - storage.buckets.writer: 인증 모드에 따라 프로젝트의 서비스 계정 또는 VM에 연결된 사용자 인증 정보에 부여해야 합니다.

Cloud Storage 버킷 로그 파일이 gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz에 기록됩니다.
relative_path

string

선택사항입니다. 진단 로그가 작성될 Cloud Storage 버킷의 상대 저장소 경로를 정의합니다. 기본 경로는 Cloud Storage 버킷의 루트 디렉터리 (gs://$GCS_BUCKET/$DATE_$TIME.tar.gz)입니다. 로그 파일이 작성될 전체 경로의 예: gs://$GCS_BUCKET/$RELATIVE_PATH/
repair_flag_enabled

bool

선택사항입니다. 인스턴스의 서비스 수리를 위한 플래그를 사용 설정합니다.
packet_capture_flag_enabled

bool

선택사항입니다. 인스턴스에서 30초 동안 패킷을 캡처하는 플래그를 사용 설정합니다.
copy_home_files_flag_enabled

bool

선택사항입니다. 모든 /home/jupyter 폴더 콘텐츠를 복사하는 플래그 사용 설정

EncryptionConfig

리소스에 적용할 수 있는 커스텀 암호화 키 구성을 나타냅니다. 이렇게 하면 가상 머신의 모든 디스크가 암호화됩니다.

필드
kms_key

string

디스크와 같은 리소스를 보호하는 데 사용되는 고객 관리 암호화 키의 Cloud KMS 리소스 식별자입니다. 형식은 projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}입니다.

환경

노트북 인스턴스를 시작하는 데 사용되는 소프트웨어 환경의 정의입니다.

필드
name

string

출력 전용입니다. 이 환경의 이름입니다. 형식: projects/{project_id}/locations/{location}/environments/{environment_id}
display_name

string

UI에 표시되는 이 환경의 표시 이름입니다.
description

string

이 환경에 대한 간단한 설명입니다.
post_startup_script

string

노트북 인스턴스가 완전히 부팅된 후 자동으로 실행되는 Bash 스크립트의 경로입니다. 경로는 URL 또는 Cloud Storage 경로여야 합니다. 예: "gs://path-to-file/file-name"
create_time

Timestamp

출력 전용입니다. 이 환경이 생성된 시간입니다.
통합 필드 image_type. 환경 유형입니다. VM 이미지 또는 컨테이너 이미지 중 하나일 수 있습니다. image_type은 다음 중 하나여야 합니다.
vm_image

VmImage

Compute Engine VM 이미지를 사용하여 노트북 인스턴스를 시작합니다.
container_image

ContainerImage

컨테이너 이미지를 사용하여 노트북 인스턴스를 시작합니다.

이벤트

관리형 / 반관리형 노트북 인스턴스의 이벤트 정의입니다.

필드
report_time

Timestamp

이벤트 보고 시간입니다.
type

EventType

이벤트 유형입니다.
details

map<string, string>

선택사항입니다. 이벤트 세부정보입니다. 이 필드는 이벤트 정보를 전달하는 데 사용됩니다.

EventType

이벤트 유형의 정의입니다.

열거형
EVENT_TYPE_UNSPECIFIED 이벤트가 지정되지 않았습니다.
IDLE 인스턴스 / 런타임이 유휴 상태입니다.
HEARTBEAT 인스턴스 / 런타임을 사용할 수 있습니다. 이 이벤트는 인스턴스 / 런타임 기본 컴퓨팅이 작동 중임을 나타냅니다.
HEALTH 인스턴스 / 런타임 상태를 사용할 수 있습니다. 이 이벤트는 인스턴스 / 런타임 상태 정보를 나타냅니다.
MAINTENANCE 인스턴스 / 런타임을 사용할 수 있습니다. 이 이벤트를 통해 인스턴스 / 런타임이 컨트롤 플레인에 호스트 유지보수 정보를 전송할 수 있습니다. https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance

실행

실행된 단일 노트북의 정의입니다.

필드
execution_template

ExecutionTemplate

이름, 하드웨어 사양, 리전, 라벨 등을 포함한 메타데이터를 실행합니다.
name

string

출력 전용입니다. 실행의 리소스 이름입니다. 형식: projects/{project_id}/locations/{location}/executions/{execution_id}
display_name

string

출력 전용입니다. UI 목적으로 사용되는 이름입니다. 이름에는 영숫자 문자와 밑줄 '_'만 포함할 수 있습니다.
description

string

이 실행에 대한 간단한 설명입니다.
create_time

Timestamp

출력 전용입니다. 실행이 인스턴스화된 시간입니다.
update_time

Timestamp

출력 전용입니다. 실행이 마지막으로 업데이트된 시간입니다.
state

State

출력 전용입니다. 기본 AI Platform 작업의 상태입니다.
output_notebook_file

string

이 실행으로 생성된 노트북 파일 출력
job_uri

string

출력 전용입니다. 노트북을 실행하는 데 사용되는 외부 작업의 URI입니다.

주

기본 AIP 작업의 상태에 관한 열거형 설명입니다.

열거형
STATE_UNSPECIFIED 작업 상태가 지정되지 않았습니다.
QUEUED 작업이 방금 생성되었으며 아직 처리가 시작되지 않았습니다.
PREPARING 서비스가 작업 실행을 준비 중입니다.
RUNNING 작업이 진행 중입니다.
SUCCEEDED 작업이 완료되었습니다.
FAILED 작업이 실패했습니다. error_message는 실패에 대한 세부정보를 포함해야 합니다.
CANCELLING 작업을 취소하는 중입니다. error_message는 취소 이유를 설명해야 합니다.
CANCELLED 작업이 취소되었습니다. error_message는 취소 이유를 설명해야 합니다.
EXPIRED 작업이 만료되었습니다 (Agent Platform 작업과 관련됨). https://cloud.google.com/gemini-enterprise-agent-platform/reference/rest/v1/JobState
INITIALIZING 실행을 만드는 중입니다.

ExecutionTemplate

노트북 실행 워크로드에 대한 설명입니다.

필드
scale_tier
(deprecated)

ScaleTier

필수 항목입니다. 노트북 실행에 사용되는 하드웨어의 확장 등급입니다. 지원 중단됩니다. 현재는 CUSTOM만 지원됩니다.
master_type

string

학습 작업의 마스터 작업자에 사용할 가상 머신의 유형을 지정합니다. scaleTier가 CUSTOM으로 설정된 경우 이 필드를 지정해야 합니다.

이 필드에 특정 Compute Engine 머신 유형을 직접 사용할 수 있습니다. 지원되는 유형은 다음과 같습니다.

  • n1-standard-4
  • n1-standard-8
  • n1-standard-16
  • n1-standard-32
  • n1-standard-64
  • n1-standard-96
  • n1-highmem-2
  • n1-highmem-4
  • n1-highmem-8
  • n1-highmem-16
  • n1-highmem-32
  • n1-highmem-64
  • n1-highmem-96
  • n1-highcpu-16
  • n1-highcpu-32
  • n1-highcpu-64
  • n1-highcpu-96

또는 다음과 같은 기존 머신 유형을 사용할 수 있습니다.

  • standard
  • large_model
  • complex_model_s
  • complex_model_m
  • complex_model_l
  • standard_gpu
  • complex_model_m_gpu
  • complex_model_l_gpu
  • standard_p100
  • complex_model_m_p100
  • standard_v100
  • large_model_v100
  • complex_model_m_v100
  • complex_model_l_v100

마지막으로 학습에 TPU를 사용하려면 이 필드에 cloud_tpu를 지정합니다. TPU를 사용한 학습용 특수 구성 옵션에 대해 자세히 알아보세요.
accelerator_config

SchedulerAcceleratorConfig

노트북 실행을 실행하는 하드웨어의 구성 (수 및 가속기 유형)입니다.
labels

map<string, string>

실행 라벨입니다. 실행이 예약된 경우 포함되는 필드는 'nbs-scheduled'입니다. 그렇지 않으면 즉시 실행되며 포함된 필드는 'nbs-immediate'입니다. 필드를 사용하여 다양한 유형의 실행 간에 효율적으로 색인을 생성합니다.
input_notebook_file

string

실행할 노트북 파일의 경로입니다. Google Cloud Storage 버킷에 있어야 합니다. 형식: gs://{bucket_name}/{folder}/{notebook_file_name} 예: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
container_image_uri

string

DLVM의 컨테이너 이미지 URI입니다(예: 'gcr.io/deeplearning-platform-release/base-cu100'). 자세한 예는 https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container를 참고하세요.
output_notebook_folder

string

쓸 노트북 폴더의 경로입니다. Google Cloud Storage 버킷 경로에 있어야 합니다. 형식: gs://{bucket_name}/{folder} 예: gs://notebook_user/scheduled_notebooks
params_yaml_file

string

실행 중에 노트북에서 재정의할 매개변수입니다. 입력 노트북에서 매개변수를 지정하고 YAML 파일에서 여기에 전달하는 방법은 https://papermill.readthedocs.io/en/latest/usage-parameterize.html을 참고하세요. 예: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
parameters

string

'input_notebook_file' 노트북 내에서 사용되는 매개변수입니다.
service_account

string

실행을 실행할 때 사용할 서비스 계정의 이메일 주소입니다. 지정된 서비스 계정에 iam.serviceAccounts.actAs 권한이 있어야 합니다.
job_type

JobType

이 실행에 사용할 작업의 유형입니다.
kernel_spec

string

사용할 커널 사양의 이름입니다. 실행 타겟의 커널 사양 이름이 입력 노트북 파일의 이름과 일치하지 않는 경우 이를 지정해야 합니다.
tensorboard

string

이 실행이 Tensorboard 로그를 업로드할 에이전트 플랫폼 [Tensorboard] 리소스의 이름입니다. 형식: projects/{project}/locations/{location}/tensorboards/{tensorboard}
통합 필드 job_parameters. 실행 유형의 매개변수입니다. 참고: 현재 VertexAI 작업에 대한 추가 매개변수는 없습니다. job_parameters은 다음 중 하나여야 합니다.
dataproc_parameters

DataprocParameters

Dataproc JobType 실행에 사용되는 매개변수입니다.
vertex_ai_parameters

VertexAIParameters

Agent Platform JobType 실행에 사용되는 파라미터입니다.

DataprocParameters

Dataproc JobType 실행에 사용되는 매개변수입니다.

필드
cluster

string

Dataproc 실행을 실행하는 데 사용되는 클러스터의 URI입니다. 형식: projects/{PROJECT_ID}/regions/{REGION}/clusters/{CLUSTER_NAME}

JobType

이 실행에 사용된 백엔드입니다.

열거형
JOB_TYPE_UNSPECIFIED 유형이 지정되지 않았습니다.
VERTEX_AI aiplatform.googleapis.com의 커스텀 작업 실행의 기본값입니다.
DATAPROC Dataproc을 작업으로 사용하여 클러스터에서 실행을 실행합니다. https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs

ScaleTier

필수 항목입니다. 머신 유형, 작업자 및 매개변수 서버의 복제본의 개수를 지정합니다.

열거형
SCALE_TIER_UNSPECIFIED 지정되지 않은 확장 등급입니다.
BASIC 단일 작업자 인스턴스입니다. 이 등급은 Cloud ML 사용 방법을 학습하고 소규모 데이터세트를 사용하여 새 모델을 실험하는 데 적합합니다.
STANDARD_1 적은 매개변수 서버와 많은 작업자입니다.
PREMIUM_1 많은 매개변수 서버와 많은 작업자입니다.
BASIC_GPU K80 GPU가 있는 단일 작업자 인스턴스입니다.
BASIC_TPU Cloud TPU가 있는 단일 작업자 인스턴스입니다.
CUSTOM

CUSTOM 등급은 설정된 등급이 아니며 사용자가 자신의 클러스터 사양을 사용할 수 있습니다. 이 등급을 사용할 경우 다음 지침에 따라 값을 설정해 처리 클러스터를 구성하세요.

  • ExecutionTemplate.masterType을 반드시 설정하여 마스터 노드에 사용할 머신 유형을 지정해야 합니다. 이는 유일한 필수 설정입니다.

SchedulerAcceleratorConfig

하드웨어 가속기의 정의입니다. type와 core_count의 모든 조합이 유효한 것은 아닙니다. 유효한 조합은 Compute Engine의 GPU를 참고하세요. TPU는 지원되지 않습니다.

필드
type

SchedulerAcceleratorType

이 가속기의 유형입니다.
core_count

int64

이 액셀러레이터의 코어 수입니다.

SchedulerAcceleratorType

AI Platform Training 작업의 하드웨어 가속기 유형입니다.

열거형
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED 지정되지 않은 가속기 유형입니다. 기본값은 GPU 없음입니다.
NVIDIA_TESLA_K80 Nvidia Tesla K80 GPU.
NVIDIA_TESLA_P100 Nvidia Tesla P100 GPU.
NVIDIA_TESLA_V100 Nvidia Tesla V100 GPU.
NVIDIA_TESLA_P4 Nvidia Tesla P4 GPU.
NVIDIA_TESLA_T4 Nvidia Tesla T4 GPU.
NVIDIA_TESLA_A100 Nvidia Tesla A100 GPU.
TPU_V2 TPU v2.
TPU_V3 TPU v3.

VertexAIParameters

Agent Platform JobType 실행에 사용되는 파라미터입니다.

필드
network

string

작업을 피어링해야 하는 Compute Engine 네트워크의 전체 이름입니다. 예를 들면 projects/12345/global/networks/myVPC입니다. Format은 projects/{project}/global/networks/{network} 형식입니다. 여기서 {project}은 12345와 같은 프로젝트 번호이고 {network}은 네트워크 이름입니다.

비공개 서비스 액세스가 이미 네트워크에 구성되어 있어야 합니다. 지정하지 않으면 작업이 네트워크와 피어링되지 않습니다.
env

map<string, string>

환경 변수 환경 변수는 최대 100개까지 지정할 수 있으며 고유해야 합니다. 예: GCP_BUCKET=gs://my-bucket/samples/

GetEnvironmentRequest

노트북 환경 가져오기 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/environments/{environment_id}

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

  • notebooks.environments.get

GetExecutionRequest

예약된 노트북 실행 가져오기 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/executions/{execution_id}

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

  • notebooks.executions.get

GetInstanceHealthRequest

노트북 인스턴스가 정상인지 확인하기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.getHealth

GetInstanceHealthResponse

노트북 인스턴스가 정상인지 확인하는 응답입니다.

필드
health_state

HealthState

출력 전용입니다. 런타임 health_state입니다.
health_info

map<string, string>

출력 전용입니다. 인스턴스 상태에 대한 추가 정보입니다. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" }

HealthState

인스턴스가 정상인지 여부입니다.

열거형
HEALTH_STATE_UNSPECIFIED 인스턴스 하위 상태를 알 수 없습니다.
HEALTHY 인스턴스가 정상 상태인 것으로 알려져 있습니다 (예: 중요한 데몬이 실행 중임). ACTIVE 상태에 적용됩니다.
UNHEALTHY 인스턴스가 비정상 상태인 것으로 알려져 있습니다 (예: 중요한 데몬이 실행되지 않음). ACTIVE 상태에 적용됩니다.
AGENT_NOT_INSTALLED 인스턴스에 상태 모니터링 에이전트가 설치되어 있지 않습니다. ACTIVE 상태에 적용됩니다.
AGENT_NOT_RUNNING 인스턴스 상태 모니터링 에이전트가 실행되고 있지 않습니다. ACTIVE 상태에 적용됩니다.

GetInstanceRequest

노트북 인스턴스를 가져오기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.get

GetRuntimeRequest

관리형 노트북 런타임을 가져오기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • notebooks.runtimes.get

GetScheduleRequest

예약된 노트북을 가져오기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/schedules/{schedule_id}

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

  • notebooks.schedules.get

인스턴스

노트북 인스턴스의 정의입니다.

필드
name

string

출력 전용입니다. 이 노트북 인스턴스의 이름입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}
post_startup_script

string

노트북 인스턴스가 완전히 부팅된 후 자동으로 실행되는 Bash 스크립트의 경로입니다. 경로는 URL 또는 Cloud Storage 경로 (gs://path-to-file/file-name)여야 합니다.
proxy_uri

string

출력 전용입니다. Jupyter Notebook에 액세스하는 데 사용되는 프록시 엔드포인트입니다.
instance_owners[]

string

입력 전용입니다. 생성 후 이 인스턴스의 소유자입니다. 형식: alias@example.com

현재 소유자는 한 명만 지원됩니다. 지정하지 않으면 VM 인스턴스의 서비스 계정의 모든 서비스 계정 사용자가 인스턴스를 사용할 수 있습니다.
service_account

string

이 인스턴스의 서비스 계정으로, 다른 Google Cloud 서비스에 대한 액세스 권한을 제공합니다. 동일한 프로젝트 내에서 서비스 계정을 사용할 수 있지만 인스턴스를 사용하려면 서비스 계정 사용자 권한이 있어야 합니다.

지정하지 않으면 Compute Engine 기본 서비스 계정이 사용됩니다.
service_account_scopes[]

string

선택사항입니다. Compute Engine 인스턴스에 포함할 서비스 계정 범위의 URI입니다.

지정하지 않으면 다음 범위가 정의됩니다. - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email 기본 범위를 사용하지 않는 경우 최소한 https://www.googleapis.com/auth/compute가 필요합니다.
machine_type

string

필수 항목입니다. 이 인스턴스의 Compute Engine 머신 유형입니다.
accelerator_config

AcceleratorConfig

이 인스턴스에서 사용되는 하드웨어 가속기입니다. 가속기를 사용하는 경우 구성에 선택한 machine_type를 지원할 수 있는 충분한 vCPU와 메모리가 있는지 확인하세요.
state

State

출력 전용입니다. 이 인스턴스의 상태입니다.
install_gpu_driver

bool

최종 사용자가 Google Cloud에서 이 인스턴스에 GPU 드라이버를 설치하도록 승인했는지 여부입니다. 이 필드가 비어 있거나 false로 설정된 경우 GPU 드라이버가 설치되지 않습니다. GPU가 있는 인스턴스에만 적용됩니다.
custom_gpu_driver_path

string

GPU 드라이버가 저장된 맞춤 Cloud Storage 경로를 지정합니다. 지정하지 않으면 공식 GPU 드라이버 중에서 자동으로 선택됩니다.
boot_disk_type

DiskType

입력 전용입니다. 이 인스턴스에 연결된 부팅 디스크의 유형입니다. 기본값은 표준 영구 디스크 (PD_STANDARD)입니다.
boot_disk_size_gb

int64

입력 전용입니다. 이 인스턴스에 연결된 부팅 디스크의 크기(GB)입니다. 최대 64, 000GB(64TB)까지 가능합니다. 최소 권장 값은 100GB입니다. 지정하지 않으면 기본값은 100입니다.
data_disk_type

DiskType

입력 전용입니다. 이 인스턴스에 연결된 데이터 디스크의 유형입니다. 기본값은 표준 영구 디스크 (PD_STANDARD)입니다.
data_disk_size_gb

int64

입력 전용입니다. 이 인스턴스에 연결된 데이터 디스크의 크기(GB)입니다. 최대 64, 000GB(64TB)까지 가능합니다. 노트북과 데이터의 크기에 따라 데이터 디스크의 크기를 선택할 수 있습니다. 지정하지 않으면 기본값은 100입니다.
no_remove_data_disk

bool

입력 전용입니다. true인 경우 인스턴스를 삭제할 때 데이터 디스크가 자동 삭제되지 않습니다.
disk_encryption

DiskEncryption

입력 전용입니다. 부팅 및 데이터 디스크에 사용되는 디스크 암호화 방법입니다. 기본값은 GMEK입니다.
kms_key

string

입력 전용입니다. 디스크를 암호화하는 데 사용되는 KMS 키입니다. disk_encryption이 CMEK인 경우에만 적용됩니다. 형식: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

자체 암호화 키 사용에 대해 자세히 알아보세요.
disks[]

Disk

출력 전용입니다. 노트북 인스턴스에 디스크가 연결되었습니다.
shielded_instance_config

ShieldedInstanceConfig

선택사항입니다. 보안 VM 구성입니다. 지원되는 보안 VM 기능을 사용하는 이미지
no_public_ip

bool

true인 경우 이 인스턴스에 외부 IP가 할당되지 않습니다.
no_proxy_access

bool

true인 경우 노트북 인스턴스가 프록시에 등록되지 않습니다.
network

string

이 인스턴스가 있는 VPC의 이름입니다. 형식: projects/{project_id}/global/networks/{network_id}
subnet

string

이 인스턴스가 있는 서브넷의 이름입니다. 형식: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
labels

map<string, string>

이 인스턴스에 적용할 라벨입니다. 이러한 값은 나중에 setLabels 메서드로 수정할 수 있습니다.
metadata

map<string, string>

이 인스턴스에 적용할 커스텀 메타데이터입니다. 예를 들어 자동 백업용 Cloud Storage 버킷을 지정하려면 gcs-data-bucket 메타데이터 태그를 사용하면 됩니다. 형식은 "--metadata=gcs-data-bucket=BUCKET"입니다.
tags[]

string

선택사항입니다. 런타임에 추가할 Compute Engine 네트워크 태그입니다 (네트워크 태그 추가 참고).
upgrade_history[]

UpgradeHistoryEntry

이 인스턴스의 업그레이드 내역입니다.
nic_type

NicType

선택사항입니다. 이 인터페이스에서 사용할 vNIC 유형입니다. gVNIC 또는 VirtioNet일 수 있습니다.
reservation_affinity

ReservationAffinity

선택사항입니다. 선택적 예약 어피니티입니다. 이 필드를 설정하면 지정된 영역 컴퓨팅 예약이 이 노트북 인스턴스에 적용됩니다.
creator

string

출력 전용입니다. 원래 CreateInstance 요청을 보낸 법인의 이메일 주소입니다.
can_ip_forward

bool

선택사항입니다. IP 전달을 사용 설정할지 여부를 나타내는 플래그입니다. 기본값은 false/off입니다. https://cloud.google.com/vpc/docs/using-routes#canipforward
create_time

Timestamp

출력 전용입니다. 인스턴스 생성 시간입니다.
update_time

Timestamp

출력 전용입니다. 인스턴스 업데이트 시간입니다.
instance_migration_eligibility

InstanceMigrationEligibility

출력 전용입니다. UmN에서 WbI로의 이전 가능성을 확인합니다.
통합 필드 environment. 환경 유형입니다. VM 이미지 또는 컨테이너 이미지 중 하나일 수 있습니다. environment은 다음 중 하나여야 합니다.
vm_image

VmImage

Compute Engine VM 이미지를 사용하여 노트북 인스턴스를 시작합니다.
container_image

ContainerImage

컨테이너 이미지를 사용하여 노트북 인스턴스를 시작합니다.
migrated

bool

출력 전용입니다. 이 노트북이 Workbench 인스턴스로 마이그레이션되었는지 여부를 나타내는 불리언

AcceleratorConfig

하드웨어 가속기의 정의입니다. type와 core_count의 모든 조합이 유효한 것은 아닙니다. 유효한 조합은 Compute Engine의 GPU를 참고하세요. TPU는 지원되지 않습니다.

필드
type

AcceleratorType

이 가속기의 유형입니다.
core_count

int64

이 액셀러레이터의 코어 수입니다.

AcceleratorType

이 인스턴스에서 사용할 수 있는 하드웨어 가속기 유형의 정의입니다.

열거형
ACCELERATOR_TYPE_UNSPECIFIED 가속기 유형이 지정되지 않았습니다.
NVIDIA_TESLA_K80 가속기 유형은 Nvidia Tesla K80입니다.
NVIDIA_TESLA_P100 가속기 유형은 Nvidia Tesla P100입니다.
NVIDIA_TESLA_V100 가속기 유형은 Nvidia Tesla V100입니다.
NVIDIA_TESLA_P4 가속기 유형은 Nvidia Tesla P4입니다.
NVIDIA_TESLA_T4 가속기 유형은 Nvidia Tesla T4입니다.
NVIDIA_TESLA_A100 가속기 유형은 Nvidia Tesla A100입니다.
NVIDIA_L4 가속기 유형은 Nvidia Tesla L4입니다.
NVIDIA_A100_80GB 가속기 유형은 Nvidia Tesla A100 80GB입니다.
NVIDIA_TESLA_T4_VWS 가속기 유형은 NVIDIA Tesla T4 가상 워크스테이션입니다.
NVIDIA_TESLA_P100_VWS 가속기 유형은 NVIDIA Tesla P100 가상 워크스테이션입니다.
NVIDIA_TESLA_P4_VWS 가속기 유형은 NVIDIA Tesla P4 가상 워크스테이션입니다.
NVIDIA_H100_80GB 가속기 유형은 NVIDIA H100 80GB입니다.
NVIDIA_H100_MEGA_80GB 가속기 유형은 NVIDIA H100 Mega 80GB입니다.
TPU_V2 (출시 예정) 가속기 유형은 TPU V2입니다.
TPU_V3 (출시 예정) 가속기 유형은 TPU V3입니다.

디스크

인스턴스에 연결된 디스크 리소스입니다.

필드
auto_delete

bool

인스턴스가 삭제될 때 디스크가 자동 삭제되는지 여부를 나타냅니다 (인스턴스에서 디스크가 분리될 때는 아님).
boot

bool

부팅 디스크임을 나타냅니다. 가상 머신은 디스크의 첫 번째 파티션을 루트 파일 시스템으로 사용합니다.
device_name

string

인스턴스 내에서 실행되는 Linux 운영체제의 /dev/disk/by-id/google-* 트리에 반영되는 선택한 고유 기기 이름을 나타냅니다. 이 이름은 인스턴스 내에서 마운트, 크기 조절 등을 위해 기기를 참조하는 데 사용할 수 있습니다.

지정하지 않으면 서버는 이 디스크에 적용할 기본 기기 이름을 persistent-disk-x 형식으로 선택합니다. 여기서 x는 Google Compute Engine에서 할당한 번호입니다. 이 필드는 영구 디스크에만 적용됩니다.
disk_size_gb

int64

디스크 크기를 2진수 GB로 나타냅니다.
guest_os_features[]

GuestOsFeature

게스트 운영체제에서 사용 설정할 기능 목록을 나타냅니다. 부팅 가능한 이미지에만 적용됩니다. 사용 가능한 옵션 목록은 게스트 운영체제 기능 사용 설정을 참고하세요.
index

int64

이 디스크의 0 기반 색인입니다. 0은 부팅 디스크용으로 예약되어 있습니다. 인스턴스에 연결된 디스크가 많은 경우 각 디스크에는 고유한 색인 번호가 있습니다.
interface

string

이 디스크를 연결하는 데 사용할 디스크 인터페이스를 나타냅니다. SCSI 또는 NVME 중 하나입니다. 기본값은 SCSI입니다. 영구 디스크는 항상 SCSI를 사용해야 하며 SCSI 이외의 형식으로 영구 디스크를 연결하려고 하면 요청이 실패합니다. 로컬 SSD는 NVME 또는 SCSI를 사용할 수 있습니다. NVMe를 통한 SCSI의 성능 특성은 로컬 SSD 성능을 참고하세요. 유효한 값:

  • NVME
  • SCSI
kind

string

리소스 유형입니다. 연결된 디스크의 경우 항상 compute#attachedDisk를 계산합니다.
licenses[]

string

공개적으로 표시되는 라이선스 목록입니다. Google에서 사용하도록 예약되어 있습니다. 라이선스는 공개 및 마켓 이미지의 결제 및 집계 사용량 데이터를 나타냅니다.
mode

string

이 디스크를 연결할 모드입니다(READ_WRITE 또는 READ_ONLY). 지정하지 않으면 기본적으로 READ_WRITE 모드로 디스크가 연결됩니다. 유효한 값:

  • READ_ONLY
  • READ_WRITE
source

string

기존 영구 디스크 리소스의 유효한 부분 또는 전체 URL을 나타냅니다.
type

string

디스크 유형(SCRATCH 또는 PERSISTENT)을 나타냅니다. 유효한 값:

  • PERSISTENT
  • SCRATCH

GuestOsFeature

부팅 디스크의 게스트 OS 기능입니다.

필드
type

string

지원되는 기능의 ID입니다. 사용 가능한 옵션 목록은 게스트 운영체제 기능 사용 설정을 참고하세요. 유효한 값:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

DiskEncryption

디스크 암호화 옵션의 정의입니다.

열거형
DISK_ENCRYPTION_UNSPECIFIED 디스크 암호화가 지정되지 않았습니다.
GMEK Google 관리 암호화 키를 사용하여 부팅 디스크를 암호화합니다.
CMEK 고객 관리 암호화 키를 사용하여 부팅 디스크를 암호화합니다.

DiskType

노트북 인스턴스에 사용할 수 있는 디스크 유형입니다.

열거형
DISK_TYPE_UNSPECIFIED 디스크 유형이 설정되지 않았습니다.
PD_STANDARD 표준 영구 디스크 유형입니다.
PD_SSD SSD 영구 디스크 유형입니다.
PD_BALANCED 균형 있는 영구 디스크 유형입니다.
PD_EXTREME 익스트림 영구 디스크 유형입니다.

NicType

vNIC 드라이버의 유형입니다. 기본값은 UNSPECIFIED_NIC_TYPE이어야 합니다.

열거형
UNSPECIFIED_NIC_TYPE 유형이 지정되지 않았습니다.
VIRTIO_NET VIRTIO
GVNIC gVNIC

ShieldedInstanceConfig

보안 인스턴스 옵션 집합입니다. 지원되는 보안 VM 기능을 사용하는 이미지를 참고하세요. 일부 조합은 유효하지 않습니다.

필드
enable_secure_boot

bool

인스턴스에 보안 부팅이 사용 설정되었는지 여부를 정의합니다.

보안 부팅은 모든 부팅 구성요소의 디지털 서명을 확인하고 서명 확인에 실패할 경우 부팅 프로세스를 중지하여 시스템에서 신뢰할 수 있는 소프트웨어만 실행하도록 합니다. 기본적으로 사용 중지됩니다.
enable_vtpm

bool

인스턴스에 vTPM이 사용 설정되었는지 여부를 정의합니다. 기본적으로 사용 설정됩니다.
enable_integrity_monitoring

bool

인스턴스에 무결성 모니터링이 사용 설정되었는지 여부를 정의합니다.

인스턴스의 부팅 무결성 모니터링 및 증명을 사용 설정합니다. 증명은 무결성 정책 기준에 따라 실행됩니다. 이 기준은 인스턴스 생성 시 암시적으로 신뢰할 수 있는 부팅 이미지에서 처음 파생됩니다. 기본적으로 사용 설정됩니다.

주

이 인스턴스의 상태 정의입니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았습니다.
STARTING 제어 로직이 인스턴스를 시작하고 있습니다.
PROVISIONING 제어 로직은 필수 프레임워크를 설치하고 노트북 프록시에 인스턴스를 등록하는 것입니다.
ACTIVE 인스턴스가 실행 중입니다.
STOPPING 제어 로직이 인스턴스를 중지하고 있습니다.
STOPPED 인스턴스가 중지되었습니다.
DELETED 인스턴스가 삭제되었습니다.
UPGRADING 인스턴스가 업그레이드 중입니다.
INITIALIZING 인스턴스를 만드는 중입니다.
REGISTERING 인스턴스가 등록되고 있습니다.
SUSPENDING 인스턴스가 정지되는 중입니다.
SUSPENDED 인스턴스가 정지되었습니다.

UpgradeHistoryEntry

VM 이미지 업그레이드 기록 항목입니다.

필드
snapshot

string

업그레이드 전 이 노트북 인스턴스의 부팅 디스크 스냅샷입니다.
vm_image

string

이 인스턴스 업그레이드 전의 VM 이미지입니다.
container_image

string

이 인스턴스 업그레이드 전의 컨테이너 이미지입니다.
framework

string

이 노트북 인스턴스의 프레임워크입니다.
version

string

이 업그레이드 전의 노트북 인스턴스 버전입니다.
state

State

이 인스턴스 업그레이드 기록 항목의 상태입니다.
create_time

Timestamp

이 인스턴스 업그레이드 기록 항목이 생성된 시간입니다.
target_image
(deprecated)

string

타겟 VM 이미지입니다. 형식은 ainotebooks-vm/project/image-name/name입니다.
action

Action

작업입니다. 롤백 또는 업그레이드
target_version

string

타겟 VM 버전(예: m63)입니다.

작업

이 업그레이드 기록 항목의 작업 정의입니다.

열거형
ACTION_UNSPECIFIED 작업이 지정되지 않았습니다.
UPGRADE 업그레이드하세요.
ROLLBACK 롤백

주

이 업그레이드 기록 항목의 상태 정의입니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았습니다.
STARTED 인스턴스 업그레이드가 시작됩니다.
SUCCEEDED 인스턴스 업그레이드가 완료되었습니다.
FAILED 인스턴스 업그레이드에 실패했습니다.

InstanceConfig

업데이트할 수 있는 노트북 인스턴스 구성입니다.

필드
notebook_upgrade_schedule

string

인스턴스 자동 업그레이드를 예약하는 데 사용되는 UTC 시간대의 크론 표현식입니다. 크론 형식을 따르세요.
enable_health_monitoring

bool

핵심 내부 서비스가 실행 중인지 확인합니다.

InstanceMigrationEligibility

InstanceMigrationEligibility는 UmN에서 WbI로의 마이그레이션 가능성 정보를 나타냅니다.

필드
warnings[]

Warning

출력 전용입니다. 마이그레이션 중에 특정 구성이 기본값으로 설정됩니다.
errors[]

Error

출력 전용입니다. 특정 구성에서는 UmN을 자동으로 이전할 수 없습니다. 수동 마이그레이션이 필요합니다.

오류

이전 오류 메시지는 특정 구성으로 인해 UmN이 자동 이전 대상이 아님을 의미합니다. 수동 마이그레이션이 필요합니다.

열거형
ERROR_UNSPECIFIED 기본 유형입니다.
DATAPROC_HUB UmN은 Dataproc Hub를 사용하며 이전할 수 없습니다.

경고

이전 경고 메시지는 이전 중에 특정 구성이 기본값으로 설정됨을 의미합니다.

열거형
WARNING_UNSPECIFIED 기본 유형입니다.
UNSUPPORTED_MACHINE_TYPE UmN이 WbI에서 지원되지 않는 머신 유형을 사용합니다. 기본 머신 유형 e2-standard-4로 마이그레이션됩니다. 마이그레이션 후 사용자가 머신 유형을 변경할 수 있습니다.
UNSUPPORTED_ACCELERATOR_TYPE UmN이 WbI에서 지원되지 않는 가속기 유형을 사용합니다. 가속기 없이 마이그레이션됩니다. 사용자는 마이그레이션 후 가속기를 연결할 수 있습니다.
UNSUPPORTED_OS UmN이 WbI에서 지원되지 않는 운영체제 (예: Debian 10, Ubuntu)를 사용합니다. WbI에서는 Debian 11로 대체됩니다.
NO_REMOVE_DATA_DISK 이 UmN은 WbI에서 더 이상 사용할 수 없는 no_remove_data_disk로 구성되어 있습니다.
GCS_BACKUP 이 UmN은 WbI에서 더 이상 사용할 수 없는 Cloud Storage 백업 기능으로 구성되어 있습니다.
POST_STARTUP_SCRIPT 이 UmN은 시작 스크립트 후 스크립트로 구성됩니다. 선택적으로 마이그레이션의 post_startup_script_option를 제공하세요.

IsInstanceUpgradeableRequest

노트북 인스턴스를 업그레이드할 수 있는지 확인하는 요청입니다.

필드
notebook_instance

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.checkUpgradability
type

UpgradeType

선택사항입니다. 선택적 UpgradeType입니다. 이 필드를 설정하면 이 인스턴스를 업그레이드할 추가 컴퓨팅 이미지를 검색합니다.

IsInstanceUpgradeableResponse

노트북 인스턴스를 업그레이드할 수 있는지 확인하는 응답입니다.

필드
upgradeable

bool

인스턴스를 업그레이드할 수 있는지 여부입니다.
upgrade_version

string

업그레이드 엔드포인트를 호출하는 경우 이 인스턴스가 업그레이드될 버전입니다. 이 필드는 필드 업그레이드 가능이 true인 경우에만 채워집니다.
upgrade_info

string

업그레이드에 관한 추가 정보입니다.
upgrade_image

string

업그레이드 엔드포인트를 호출하는 경우 이 인스턴스가 업그레이드될 새 이미지 자체 링크입니다. 이 필드는 필드 업그레이드 가능이 true인 경우에만 채워집니다.

ListEnvironmentsRequest

환경 목록 요청입니다.

필드
parent

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}

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

  • notebooks.environments.list
page_size

int32

목록 호출의 최대 반환 크기입니다.
page_token

string

마지막 결과에서 목록을 계속하는 데 사용할 수 있는 이전에 반환된 페이지 토큰입니다.

ListEnvironmentsResponse

환경 목록에 대한 응답입니다.

필드
environments[]

Environment

반환된 환경 목록입니다.
next_page_token

string

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

string

도달할 수 없는 위치입니다.

ListExecutionsRequest

예약된 노트북 실행 나열 요청

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.executions.list
page_size

int32

목록 호출의 최대 반환 크기입니다.
page_token

string

마지막 결과에서 목록을 계속하는 데 사용할 수 있는 이전에 반환된 페이지 토큰입니다.
filter

string

결과 실행에 적용된 필터입니다. 현재는 지정된 schedule_id로 실행을 필터링하는 것만 지원됩니다. 형식: schedule_id=<Schedule_ID>
order_by

string

필드별 정렬

ListExecutionsResponse

예약된 노트북 실행 목록에 대한 응답

필드
executions[]

Execution

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

string

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

string

도달할 수 없는 실행 ID입니다. 예를 들면 다음과 같습니다.

['projects/{project_id}/location/{location}/executions/imagenet_test1',
 'projects/{project_id}/location/{location}/executions/classifier_train1']

ListInstancesRequest

노트북 인스턴스 목록 요청입니다.

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.instances.list
page_size

int32

목록 호출의 최대 반환 크기입니다.
page_token

string

마지막 결과에서 목록을 계속하는 데 사용할 수 있는 이전에 반환된 페이지 토큰입니다.
order_by

string

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

string

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

ListInstancesResponse

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

필드
instances[]

Instance

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

string

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

string

도달할 수 없는 위치입니다. 예를 들면 ['us-west1-a', 'us-central1-b']입니다. ListInstancesResponse에는 인스턴스 또는 연결할 수 없는 항목만 포함됩니다.

ListRuntimesRequest

관리형 노트북 런타임을 나열하는 요청입니다.

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.runtimes.list
page_size

int32

목록 호출의 최대 반환 크기입니다.
page_token

string

마지막 결과에서 목록을 계속하는 데 사용할 수 있는 이전에 반환된 페이지 토큰입니다.
order_by

string

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

string

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

ListRuntimesResponse

관리형 노트북 런타임 목록에 대한 응답입니다.

필드
runtimes[]

Runtime

반환된 런타임 목록입니다.
next_page_token

string

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

string

도달할 수 없는 위치입니다. 예를 들면 ['us-west1', 'us-central1']입니다. ListRuntimesResponse에는 런타임 또는 연결할 수 없는 항목만 포함됩니다.

ListSchedulesRequest

예약된 노트북 작업을 나열하기 위한 요청입니다.

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.schedules.list
page_size

int32

목록 호출의 최대 반환 크기입니다.
page_token

string

마지막 결과에서 목록을 계속하는 데 사용할 수 있는 이전에 반환된 페이지 토큰입니다.
filter

string

결과 일정에 적용된 필터입니다.
order_by

string

결과를 정렬할 필드입니다.

ListSchedulesResponse

예약된 노트북 작업을 나열하는 응답입니다.

필드
schedules[]

Schedule

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

string

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

string

도달할 수 없는 일정입니다. 예를 들면 다음과 같습니다.

['projects/{project_id}/location/{location}/schedules/monthly_digest',
 'projects/{project_id}/location/{location}/schedules/weekly_sentiment']

LocalDisk

로컬 연결 디스크 리소스입니다.

필드
auto_delete

bool

선택사항입니다. 출력 전용입니다. 인스턴스가 삭제될 때 디스크가 자동 삭제되는지 여부를 지정합니다 (인스턴스에서 디스크가 분리될 때는 아님).
boot

bool

선택사항입니다. 출력 전용입니다. 부팅 디스크임을 나타냅니다. 가상 머신은 디스크의 첫 번째 파티션을 루트 파일 시스템으로 사용합니다.
device_name

string

선택사항입니다. 출력 전용입니다. 인스턴스 내에서 실행되는 Linux 운영체제의 /dev/disk/by-id/google-* 트리에 반영되는 고유한 기기 이름을 지정합니다. 이 이름은 인스턴스 내에서 마운트, 크기 조절 등을 위해 기기를 참조하는 데 사용할 수 있습니다.

지정하지 않으면 서버는 이 디스크에 적용할 기본 기기 이름을 선택합니다. 기본 기기 이름은 persistent-disk-x 형식이며, 여기서 x는 Google Compute Engine에서 할당한 번호입니다. 이 필드는 영구 디스크에만 적용됩니다.
guest_os_features[]

RuntimeGuestOsFeature

출력 전용입니다. 게스트 운영체제에서 사용 설정할 기능 목록을 나타냅니다. 부팅 가능한 이미지에만 적용됩니다. 사용 가능한 옵션 목록은 게스트 운영체제 기능 사용 설정을 참고하세요.
index

int32

출력 전용입니다. 이 디스크의 0 기반 색인입니다. 0은 부팅 디스크용으로 예약되어 있습니다. 인스턴스에 연결된 디스크가 많은 경우 각 디스크에는 고유한 색인 번호가 있습니다.
initialize_params

LocalDiskInitializeParams

입력 전용입니다. 새 인스턴스와 함께 생성될 새 디스크의 매개변수를 지정합니다. 초기화 매개변수를 사용하여 새 인스턴스에 연결된 부팅 디스크 또는 로컬 SSD를 만듭니다.

이 속성은 소스 속성과 상호 배타적입니다. 둘 중 하나만 정의할 수 있으며 둘 다 정의할 수는 없습니다.
interface

string

이 디스크를 연결하는 데 사용할 디스크 인터페이스를 지정합니다. SCSI 또는 NVME 중 하나입니다. 기본값은 SCSI입니다. 영구 디스크는 항상 SCSI를 사용해야 하며 SCSI 이외의 형식으로 영구 디스크를 연결하려고 하면 요청이 실패합니다. 로컬 SSD는 NVME 또는 SCSI를 사용할 수 있습니다. NVMe를 통한 SCSI의 성능 특성은 로컬 SSD 성능을 참고하세요. 유효한 값:

  • NVME
  • SCSI
kind

string

출력 전용입니다. 리소스 유형입니다. 연결된 디스크의 경우 항상 compute#attachedDisk를 계산합니다.
licenses[]

string

출력 전용입니다. 유효하고 공개적으로 표시되는 라이선스
mode

string

이 디스크를 연결할 모드입니다(READ_WRITE 또는 READ_ONLY). 지정하지 않으면 기본적으로 READ_WRITE 모드로 디스크가 연결됩니다. 유효한 값:

  • READ_ONLY
  • READ_WRITE
source

string

기존 영구 디스크 리소스의 유효한 부분 또는 전체 URL을 지정합니다.
type

string

디스크 유형(SCRATCH 또는 PERSISTENT)을 지정합니다. 지정하지 않으면 기본값은 PERSISTENT입니다. 유효한 값:

  • PERSISTENT
  • SCRATCH

RuntimeGuestOsFeature

선택사항입니다. 게스트 운영체제에서 사용 설정할 기능 목록입니다. 부팅 가능한 이미지에만 적용됩니다. 게스트 운영체제 기능 사용 설정에서 사용 가능한 옵션 목록을 확인하세요. 부팅 디스크의 게스트 OS 기능입니다.

필드
type

string

지원되는 기능의 ID입니다. 게스트 운영체제 기능 사용 설정에서 사용 가능한 옵션 목록을 확인하세요.

유효한 값:

  • FEATURE_TYPE_UNSPECIFIED
  • MULTI_IP_SUBNET
  • SECURE_BOOT
  • UEFI_COMPATIBLE
  • VIRTIO_SCSI_MULTIQUEUE
  • WINDOWS

LocalDiskInitializeParams

입력 전용입니다. 새 인스턴스와 함께 생성될 새 디스크의 매개변수를 지정합니다. 초기화 매개변수를 사용하여 새 런타임에 연결된 부팅 디스크 또는 로컬 SSD를 만듭니다. 이 속성은 소스 속성과 상호 배타적입니다. 둘 중 하나만 정의할 수 있으며 둘 다 정의할 수는 없습니다.

필드
description

string

선택사항입니다. 디스크를 만들 때 이 속성을 제공하세요.
disk_name

string

선택사항입니다. 디스크 이름을 지정합니다. 지정하지 않으면 인스턴스 이름을 사용하는 것이 기본값입니다. 인스턴스 이름이 지정된 디스크가 지정된 영역/리전에 이미 있는 경우 새 이름이 자동으로 생성됩니다.
disk_size_gb

int64

선택사항입니다. 디스크 크기를 2진수 GB로 지정합니다. 지정하지 않으면 디스크 크기는 이미지 크기 (일반적으로 10GB)와 동일합니다. 지정된 경우 크기는 10GB 이상이어야 합니다. 기본값은 100GB입니다.
disk_type

DiskType

입력 전용입니다. 이 인스턴스에 연결된 부팅 디스크의 유형입니다. 기본값은 표준 영구 디스크 (PD_STANDARD)입니다.
labels

map<string, string>

선택사항입니다. 이 디스크에 적용할 라벨입니다. 이러한 라벨은 나중에 disks.setLabels 메서드로 수정할 수 있습니다. 이 필드는 영구 디스크에만 적용됩니다.

DiskType

가능한 디스크 유형입니다.

열거형
DISK_TYPE_UNSPECIFIED 디스크 유형이 설정되지 않았습니다.
PD_STANDARD 표준 영구 디스크 유형입니다.
PD_SSD SSD 영구 디스크 유형입니다.
PD_BALANCED 균형 있는 영구 디스크 유형입니다.
PD_EXTREME 익스트림 영구 디스크 유형입니다.

MigrateInstanceRequest

사용자 관리 노트북을 워크벤치 인스턴스로 마이그레이션하기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

승인을 처리하려면 지정된 리소스 name에 대해 다음 IAM 권한 중 하나 이상이 필요합니다.

  • notebooks.instances.get
  • notebooks.instances.create
post_startup_script_option

PostStartupScriptOption

선택사항입니다. 마이그레이션 중 시작 스크립트 후 스크립트의 동작을 지정합니다.

PostStartupScriptOption

마이그레이션 중 시작 스크립트 후 스크립트의 동작을 지정합니다.

열거형
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 시작 스크립트 옵션이 지정되지 않았습니다. 기본값은 POST_STARTUP_SCRIPT_OPTION_SKIP입니다.
POST_STARTUP_SCRIPT_OPTION_SKIP 시작 스크립트를 새 Workbench 인스턴스로 마이그레이션하지 않습니다.
POST_STARTUP_SCRIPT_OPTION_RERUN 사용자 관리 노트북으로 동일한 시작 스크립트를 다시 다운로드하고 다시 실행합니다.

MigrateInstanceResponse

이 유형에는 필드가 없습니다.

MigrateInstance의 빈 메시지 응답 유형입니다.

MigrateRuntimeRequest

런타임을 Workbench 인스턴스로 마이그레이션하기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

승인을 처리하려면 지정된 리소스 name에 대해 다음 IAM 권한 중 하나 이상이 필요합니다.

  • notebooks.runtimes.get
  • notebooks.instances.create
network

string

선택사항입니다. 새 인스턴스가 있는 VPC의 이름입니다. 런타임이 Google 관리 네트워크를 사용하는 경우 필요합니다. 런타임이 고객 소유 네트워크를 사용하는 경우 동일한 VPC를 재사용하므로 이 필드는 비어 있어야 합니다. 형식: projects/{project_id}/global/networks/{network_id}
subnet

string

선택사항입니다. 새 인스턴스가 있는 서브넷의 이름입니다. 런타임이 Google 관리 네트워크를 사용하는 경우 필요합니다. 런타임이 고객 소유 네트워크를 사용하는 경우 동일한 서브넷을 재사용하므로 이 필드는 비워야 합니다. 형식: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
service_account

string

선택사항입니다. 런타임에서 권한에 '단일 사용자 전용' 모드를 사용하는 경우 새 Workbench 인스턴스의 Compute Engine 인스턴스에 포함할 서비스 계정입니다. 지정하지 않으면 Compute Engine 기본 서비스 계정이 사용됩니다. 런타임에서 권한에 서비스 계정 모드를 사용하는 경우 동일한 서비스 계정을 재사용하므로 이 필드는 비어 있어야 합니다.
request_id

string

선택사항입니다. 멱등성 요청 UUID입니다.
post_startup_script_option

PostStartupScriptOption

선택사항입니다. 마이그레이션 중 시작 스크립트 후 스크립트의 동작을 지정합니다.

PostStartupScriptOption

마이그레이션 중 시작 스크립트 후 스크립트의 동작을 지정합니다.

열거형
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED 시작 스크립트 옵션이 지정되지 않았습니다. 기본값은 POST_STARTUP_SCRIPT_OPTION_SKIP입니다.
POST_STARTUP_SCRIPT_OPTION_SKIP 시작 스크립트를 새 Workbench 인스턴스로 마이그레이션하지 않습니다.
POST_STARTUP_SCRIPT_OPTION_RERUN Google 관리 노트북과 동일한 시작 스크립트를 다시 다운로드하고 다시 실행합니다.

OperationMetadata

장기 실행 작업의 메타데이터를 나타냅니다.

필드
create_time

Timestamp

작업이 생성된 시간입니다.
end_time

Timestamp

작업 실행이 완료된 시간입니다.
target

string

작업 대상에 대한 서버 정의 리소스 경로입니다.
verb

string

작업에 의해 실행된 동사의 이름입니다.
status_message

string

작업의 사람이 읽을 수 있는 상태입니다(있는 경우).
requested_cancellation

bool

사용자가 작업 취소를 요청했는지를 나타냅니다. 성공적으로 취소된 작업에는 google.rpc.Status.code가 1인 google.longrunning.Operation.error 값이 있습니다. 이는 Code.CANCELLED에 해당합니다.
api_version

string

작업을 시작하는 데 사용되는 API 버전입니다.
endpoint

string

이 작업의 API 엔드포인트 이름입니다.

RegisterInstanceRequest

노트북 인스턴스 등록 요청입니다.

필드
parent

string

필수 항목입니다. 형식: parent=projects/{project_id}/locations/{location}

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

  • notebooks.instances.create
instance_id

string

필수 항목입니다. 이 인스턴스의 사용자 정의 고유 ID입니다. instance_id는 1~63자(영문 기준)여야 하며 소문자, 숫자, 대시만 포함해야 합니다. 첫 번째 문자는 소문자여야 하며 마지막 문자는 대시가 아니어야 합니다.

ReportInstanceInfoRequest

노트북 인스턴스가 Notebooks API에 정보를 보고하도록 요청합니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}
vm_id

string

필수 항목입니다. VM을 인증하기 위한 VM 하드웨어 토큰입니다. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
metadata

map<string, string>

Notebooks API에 보고된 메타데이터입니다. 인스턴스 메타데이터 스토어로 병합됩니다.

ReportRuntimeEventRequest

관리형 노트북 이벤트를 보고하기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • iam.permissions.none
vm_id

string

필수 항목입니다. VM을 인증하기 위한 VM 하드웨어 토큰입니다. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event

Event

필수 항목입니다. 신고할 이벤트입니다.

ReservationAffinity

영역 예약 사용을 위한 예약 어피니티입니다.

필드
consume_reservation_type

Type

선택사항입니다. 사용할 예약 유형
key

string

선택사항입니다. 예약 리소스의 라벨 키에 해당합니다.
values[]

string

선택사항입니다. 예약 리소스의 라벨 값에 해당합니다.

유형

예약에서 용량을 사용할지 여부를 나타냅니다.

열거형
TYPE_UNSPECIFIED 기본 유형입니다.
NO_RESERVATION 할당된 용량을 사용하지 않습니다.
ANY_RESERVATION 사용 가능한 예약을 사용합니다.
SPECIFIC_RESERVATION 특정 예약에서 사용해야 합니다. 예약을 지정하기 위한 키 값 필드를 지정해야 합니다.

ResetInstanceRequest

노트북 인스턴스 재설정 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.reset

ResetRuntimeRequest

관리형 노트북 런타임 재설정 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • notebooks.runtimes.reset
request_id

string

멱등성 요청 UUID입니다.

RollbackInstanceRequest

노트북 인스턴스 롤백 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • iam.permissions.none
target_snapshot

string

필수 항목입니다. 롤백할 스냅샷입니다. 예: projects/test-project/global/snapshots/krwlzipynril

런타임

관리형 노트북 인스턴스의 런타임 정의입니다.

필드
name

string

출력 전용입니다. 런타임의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/runtimes/{runtimeId}
state

State

출력 전용입니다. 런타임 상태입니다.
health_state

HealthState

출력 전용입니다. 런타임 health_state입니다.
access_config

RuntimeAccessConfig

런타임 액세스를 위한 구성 설정입니다.
software_config

RuntimeSoftwareConfig

런타임 내 소프트웨어의 구성 설정입니다.
metrics

RuntimeMetrics

출력 전용입니다. 서비스 상태, JupyterLab 통계와 같은 런타임 데몬 측정항목을 포함합니다.
create_time

Timestamp

출력 전용입니다. 런타임 생성 시간입니다.
update_time

Timestamp

출력 전용입니다. 런타임 업데이트 시간입니다.
labels

map<string, string>

선택사항입니다. 이 관리형 노트북 또는 런타임과 연결할 라벨입니다. 라벨 키는 1~63자(영문 기준)여야 하며 RFC 1035를 준수해야 합니다. 라벨 값은 비어 있어도 되지만, 있는 경우 1~63자(영문 기준)여야 하며 RFC 1035를 준수해야 합니다. 클러스터와 연결할 수 있는 라벨은 32개 미만입니다.
runtime_migration_eligibility

RuntimeMigrationEligibility

출력 전용입니다. GmN에서 WbI로의 이전 가능성을 확인합니다.
통합 필드 runtime_type. 런타임 유형입니다. 현재 Compute Engine VM만 지원합니다. runtime_type은 다음 중 하나여야 합니다.
virtual_machine

VirtualMachine

Compute Engine VM 이미지를 사용하여 관리형 노트북 인스턴스를 시작합니다.
migrated

bool

출력 전용입니다. 이 노트북이 Workbench 인스턴스로 마이그레이션되었는지 여부를 나타내는 불리언

HealthState

런타임 하위 상태입니다.

열거형
HEALTH_STATE_UNSPECIFIED 런타임 하위 상태를 알 수 없습니다.
HEALTHY 런타임이 정상 상태인 것으로 알려져 있습니다 (예: 중요한 데몬이 실행 중임). ACTIVE 상태에 적용됩니다.
UNHEALTHY 런타임이 비정상 상태인 것으로 알려져 있습니다 (예: 중요 데몬이 실행되지 않음). ACTIVE 상태에 적용됩니다.
AGENT_NOT_INSTALLED 런타임에 상태 모니터링 에이전트가 설치되지 않았습니다. ACTIVE 상태에 적용됩니다.
AGENT_NOT_RUNNING 런타임 상태 모니터링 에이전트가 실행되고 있지 않습니다. ACTIVE 상태에 적용됩니다.

주

이 런타임의 상태 정의입니다.

열거형
STATE_UNSPECIFIED 상태가 지정되지 않았습니다.
STARTING 컴퓨팅 레이어가 런타임을 시작하고 있습니다. 사용할 수 없습니다.
PROVISIONING 컴퓨팅 레이어에서 필수 프레임워크를 설치하고 노트북 프록시에 런타임을 등록하고 있습니다. 사용할 수 없습니다.
ACTIVE 런타임이 현재 실행 중입니다. 사용할 준비가 되었습니다.
STOPPING 제어 로직이 런타임을 중지하고 있습니다. 사용할 수 없습니다.
STOPPED 런타임이 중지되었습니다. 사용할 수 없습니다.
DELETING 런타임을 삭제하는 중입니다. 사용할 수 없습니다.
UPGRADING 런타임이 업그레이드되고 있습니다. 사용할 수 없습니다.
INITIALIZING 런타임이 생성되고 설정되는 중입니다. 사용할 수 없습니다.

RuntimeAcceleratorConfig

사용할 수 있는 하드웨어 가속기 유형의 정의입니다. Compute Engine AcceleratorTypes를 참고하세요. 예:

  • nvidia-tesla-k80
  • nvidia-tesla-p100
  • nvidia-tesla-v100
  • nvidia-tesla-p4
  • nvidia-tesla-t4
  • nvidia-tesla-a100
필드
type

AcceleratorType

가속기 모델입니다.
core_count

int64

이 액셀러레이터의 코어 수입니다.

AcceleratorType

이 가속기의 유형입니다.

열거형
ACCELERATOR_TYPE_UNSPECIFIED 가속기 유형이 지정되지 않았습니다.
NVIDIA_TESLA_K80

가속기 유형은 Nvidia Tesla K80입니다.
NVIDIA_TESLA_P100 가속기 유형은 Nvidia Tesla P100입니다.
NVIDIA_TESLA_V100 가속기 유형은 Nvidia Tesla V100입니다.
NVIDIA_TESLA_P4 가속기 유형은 Nvidia Tesla P4입니다.
NVIDIA_TESLA_T4 가속기 유형은 Nvidia Tesla T4입니다.
NVIDIA_TESLA_A100 가속기 유형은 Nvidia Tesla A100 - 40GB입니다.
NVIDIA_L4 가속기 유형은 Nvidia L4입니다.
TPU_V2 (출시 예정) 가속기 유형은 TPU V2입니다.
TPU_V3 (출시 예정) 가속기 유형은 TPU V3입니다.
NVIDIA_TESLA_T4_VWS 가속기 유형은 NVIDIA Tesla T4 가상 워크스테이션입니다.
NVIDIA_TESLA_P100_VWS 가속기 유형은 NVIDIA Tesla P100 가상 워크스테이션입니다.
NVIDIA_TESLA_P4_VWS 가속기 유형은 NVIDIA Tesla P4 가상 워크스테이션입니다.

RuntimeAccessConfig

런타임의 로그인 구성을 지정합니다.

필드
access_type

RuntimeAccessType

이 인스턴스의 액세스 모드 유형입니다.
runtime_owner

string

생성 후 이 런타임의 소유자입니다. 형식: alias@example.com 현재 소유자는 한 명만 지원됩니다.
proxy_uri

string

출력 전용입니다. 런타임에 액세스하는 데 사용되는 프록시 엔드포인트입니다.

RuntimeAccessType

런타임에 액세스할 수 있는 방법 인증 모드입니다. 현재는 단일 사용자만 지원됩니다.

열거형
RUNTIME_ACCESS_TYPE_UNSPECIFIED 액세스 권한이 지정되지 않았습니다.
SINGLE_USER 단일 사용자 로그인
SERVICE_ACCOUNT 서비스 계정 모드입니다. 서비스 계정 모드에서 런타임 생성자는 소비자 프로젝트에 있는 SA를 지정합니다. 런타임 서비스 계정 필드를 사용합니다. 런타임에 액세스하는 사용자에게는 ActAs (서비스 계정 사용자) 권한이 필요합니다.

RuntimeMetrics

OS, 커널, 세션 통계와 같은 런타임 데몬 측정항목이 포함됩니다.

필드
system_metrics

map<string, string>

출력 전용입니다. 시스템 측정항목입니다.

RuntimeMigrationEligibility

RuntimeMigrationEligibility는 GmN에서 WbI로의 이전 가능성 정보를 나타냅니다.

필드
warnings[]

Warning

출력 전용입니다. 마이그레이션 중에 특정 구성이 기본값으로 설정됩니다.
errors[]

Error

출력 전용입니다. 특정 구성에서는 GmN이 자동 이전 대상이 되지 않습니다. 수동 마이그레이션이 필요합니다.

오류

이전 오류 메시지는 특정 구성으로 인해 GmN이 자동 이전 대상이 아님을 의미합니다. 수동 마이그레이션이 필요합니다.

열거형
ERROR_UNSPECIFIED 기본 유형입니다.
CUSTOM_CONTAINER GmN이 맞춤 컨테이너로 구성되어 있어 이전할 수 없습니다.

경고

이전 경고 메시지는 이전 중에 특정 구성이 기본값으로 설정됨을 의미합니다.

열거형
WARNING_UNSPECIFIED 기본 유형입니다.
UNSUPPORTED_ACCELERATOR_TYPE GmN이 WbI에서 지원되지 않는 가속기 유형을 사용합니다. 가속기 없이 마이그레이션됩니다. 사용자는 마이그레이션 후 가속기를 연결할 수 있습니다.
UNSUPPORTED_OS GmN이 WbI에서 지원되지 않는 운영체제 (예: Debian 10)를 사용합니다. WbI에서는 Debian 11로 대체됩니다.
RESERVED_IP_RANGE 이 GmN은 WbI에서 더 이상 적용되지 않는 예약된 IP 범위로 구성되어 있습니다.
GOOGLE_MANAGED_NETWORK 이 GmN은 Google 관리 네트워크로 구성됩니다. 마이그레이션에 사용할 network 및 subnet 옵션을 제공하세요.
POST_STARTUP_SCRIPT 이 GmN은 시작 스크립트 후 스크립트로 구성됩니다. 선택적으로 마이그레이션의 post_startup_script_option를 제공하세요.
SINGLE_USER 이 GmN은 단일 사용자 모드로 구성되어 있습니다. 원하는 경우 이전의 service_account 옵션을 제공하세요.

RuntimeShieldedInstanceConfig

보안 인스턴스 옵션 집합입니다. 지원되는 보안 VM 기능을 사용하는 이미지를 참고하세요. 일부 조합은 유효하지 않습니다.

필드
enable_secure_boot

bool

인스턴스에 보안 부팅이 사용 설정되었는지 여부를 정의합니다.

보안 부팅은 모든 부팅 구성요소의 디지털 서명을 확인하고 서명 확인에 실패할 경우 부팅 프로세스를 중지하여 시스템에서 신뢰할 수 있는 소프트웨어만 실행하도록 합니다. 기본적으로 사용 중지됩니다.
enable_vtpm

bool

인스턴스에 vTPM이 사용 설정되었는지 여부를 정의합니다. 기본적으로 사용 설정됩니다.
enable_integrity_monitoring

bool

인스턴스에 무결성 모니터링이 사용 설정되었는지 여부를 정의합니다.

인스턴스의 부팅 무결성 모니터링 및 증명을 사용 설정합니다. 증명은 무결성 정책 기준에 따라 실행됩니다. 이 기준은 인스턴스 생성 시 암시적으로 신뢰할 수 있는 부팅 이미지에서 처음 파생됩니다. 기본적으로 사용 설정됩니다.

RuntimeSoftwareConfig

런타임 내 소프트웨어의 선택 및 구성을 지정합니다. 런타임에 설정할 속성입니다. 속성 키는 key:value 형식으로 지정됩니다. 예를 들면 다음과 같습니다.

  • idle_shutdown: true
  • idle_shutdown_timeout: 180
  • enable_health_monitoring: true
필드
notebook_upgrade_schedule

string

인스턴스 자동 업그레이드를 예약하는 데 사용되는 UTC 시간대의 크론 표현식입니다. cron 형식을 따르세요.
idle_shutdown_timeout

int32

런타임을 종료하기 전에 대기하는 시간(분)입니다. 기본값: 180분
install_gpu_driver

bool

Nvidia 드라이버를 자동으로 설치합니다. 기본값: True
custom_gpu_driver_path

string

GPU 드라이버가 저장된 맞춤 Cloud Storage 경로를 지정합니다. 지정하지 않으면 공식 GPU 드라이버 중에서 자동으로 선택됩니다.
post_startup_script

string

노트북 인스턴스가 완전히 부팅된 후 자동으로 실행되는 Bash 스크립트의 경로입니다. 경로는 URL 또는 Cloud Storage 경로 (gs://path-to-file/file-name)여야 합니다.
kernels[]

ContainerImage

선택사항입니다. 노트북 인스턴스에서 커널로 사용할 컨테이너 이미지 목록을 사용합니다.
post_startup_script_behavior

PostStartupScriptBehavior

시작 후 스크립트의 동작입니다.
enable_health_monitoring

bool

핵심 내부 서비스가 실행 중인지 확인합니다. 기본값: True
idle_shutdown

bool

런타임은 idle_shutdown_time이 지나면 자동으로 종료됩니다. 기본값: True
upgradeable

bool

출력 전용입니다. 이미지 계열에서 최신 이미지를 사용할 수 있는지 나타내는 불리언입니다.
disable_terminal

bool

JupyterLab 터미널의 사용 가능 여부를 나타내는 불리언입니다. 기본값: False
version

string

출력 전용입니다. 이미지의 출시 라벨에서 가져온 부팅 이미지 버전입니다(예: M100).
mixer_disabled

bool

믹서 클라이언트를 사용 중지해야 하는지 여부를 나타내는 불리언입니다. 기본값: False

PostStartupScriptBehavior

시작 후 스크립트의 동작입니다.

열거형
POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED 지정되지 않은 시작 스크립트 후 동작입니다. 생성 시에만 한 번 실행됩니다.
RUN_EVERY_START 생성 중에 제공된 시작 후 스크립트를 시작할 때마다 실행합니다.
DOWNLOAD_AND_RUN_EVERY_START 시작할 때마다 제공된 시작 스크립트를 다운로드하고 실행합니다.

일정

일정의 정의입니다.

필드
name

string

출력 전용입니다. 이 일정의 이름입니다. 형식: projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name

string

출력 전용입니다. UI 목적으로 사용되는 표시 이름입니다. 이름에는 영숫자 문자, 하이픈 -, 밑줄 _만 포함할 수 있습니다.
description

string

이 환경에 대한 간단한 설명입니다.
state

State
cron_schedule

string

작업이 실행될 크론탭 형식의 일정입니다. 형식: 분, 시간, 일, 월, 요일(예: 0 0 * * WED = 매주 수요일) 기타 예: https://crontab.guru/examples.html
time_zone

string

cron_schedule의 시간대입니다. 이 필드의 값은 tz 데이터베이스의 시간대 이름이어야 합니다. TZ 데이터베이스: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

일부 시간대에는 일광 절약 시간 조항이 포함되어 있습니다. 일광 절약 시간 규칙은 선택한 tz에 따라 결정됩니다. UTC의 경우 'utc' 문자열을 사용합니다. 시간대를 지정하지 않으면 기본값은 UTC (GMT라고도 함)입니다.
create_time

Timestamp

출력 전용입니다. 일정이 생성된 시간입니다.
update_time

Timestamp

출력 전용입니다. 일정이 마지막으로 업데이트된 시간입니다.
execution_template

ExecutionTemplate

이 일정에 해당하는 노트북 실행 템플릿입니다.
recent_executions[]

Execution

출력 전용입니다. 이 일정에서 트리거된 가장 최근 실행 이름과 해당 상태입니다.

주

작업 상태입니다.

열거형
STATE_UNSPECIFIED 지정되지 않은 상태입니다.
ENABLED 작업이 정상적으로 실행되고 있습니다.
PAUSED 사용자가 작업을 일시중지했습니다. 실행되지 않습니다. 사용자는 Cloud Scheduler를 사용하여 작업을 의도적으로 일시중지할 수 있습니다.
DISABLED 오류로 인해 시스템에서 작업을 사용 중지했습니다. 사용자는 작업을 사용 중지하도록 직접 설정할 수 없습니다.
UPDATE_FAILED 실패한 CloudScheduler.UpdateJob 작업으로 인해 발생하는 작업 상태입니다. 이 상태에서 작업을 복구하려면 성공적인 응답이 수신될 때까지 CloudScheduler.UpdateJob을 다시 시도하세요.
INITIALIZING 일정 리소스를 만드는 중입니다.
DELETING 일정 리소스가 삭제되는 중입니다.

SetInstanceAcceleratorRequest

인스턴스 가속기 설정 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.setAccelerator
type

AcceleratorType

필수 항목입니다. 이 가속기의 유형입니다.
core_count

int64

필수 항목입니다. 이 액셀러레이터의 코어 수입니다. type와 core_count의 모든 조합이 유효한 것은 아닙니다. 유효한 조합은 Compute Engine의 GPU를 참고하세요. TPU는 지원되지 않습니다.

SetInstanceLabelsRequest

인스턴스 라벨 설정 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.setLabels
labels

map<string, string>

이 인스턴스에 적용할 라벨입니다. 나중에 setLabels 메서드로 수정할 수 있습니다.

SetInstanceMachineTypeRequest

인스턴스 머신 유형 설정 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.setMachineType
machine_type

string

필수 항목입니다. Compute Engine 머신 유형입니다.

StartInstanceRequest

노트북 인스턴스 시작 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.start

StartRuntimeRequest

관리형 노트북 런타임 시작 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • notebooks.runtimes.start
request_id

string

멱등성 요청 UUID입니다.

StopInstanceRequest

노트북 인스턴스 중지 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.stop

StopRuntimeRequest

관리형 노트북 런타임 중지 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • notebooks.runtimes.stop
request_id

string

멱등성 요청 UUID입니다.

SwitchRuntimeRequest

관리형 노트북 런타임 전환 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

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

  • notebooks.runtimes.switch
machine_type

string

머신 유형
accelerator_config

RuntimeAcceleratorConfig

액셀러레이터 구성
request_id

string

멱등성 요청 UUID입니다.

UpdateInstanceConfigRequest

인스턴스 구성 업데이트 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.updateConfig
config

InstanceConfig

업데이트할 인스턴스 구성입니다.

UpdateInstanceMetadataItemsRequest

인스턴스의 메타데이터 항목을 추가/변경하기 위한 요청입니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.updateConfig
items

map<string, string>

인스턴스에 추가/업데이트할 메타데이터 항목입니다.

UpdateInstanceMetadataItemsResponse

인스턴스의 메타데이터 항목 추가/변경에 대한 응답입니다.

필드
items

map<string, string>

메타데이터에 추가/업데이트된 항목의 맵입니다.

UpdateRuntimeRequest

관리형 노트북 구성 업데이트 요청입니다.

필드
runtime

Runtime

필수 항목입니다. 업데이트할 런타임입니다.

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

  • notebooks.runtimes.update
update_mask

FieldMask

필수 항목입니다. 업데이트할 필드의 경로(Runtime 기준)를 지정합니다. 예를 들어 소프트웨어 구성 커널을 변경하려면 update_mask 매개변수는 software_config.kernels으로 지정되고 PATCH 요청 본문은 다음과 같은 새 값을 지정합니다.

{
  "software_config":{
    "kernels": [{
       'repository':
       'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
       'latest' }],
    }
}

현재 업데이트할 수 있는 필드는 다음과 같습니다.

  • software_config.kernels
  • software_config.post_startup_script
  • software_config.custom_gpu_driver_path
  • software_config.idle_shutdown
  • software_config.idle_shutdown_timeout
  • software_config.disable_terminal
  • labels
request_id

string

멱등성 요청 UUID입니다.

UpdateShieldedInstanceConfigRequest

노트북 인스턴스의 보안 인스턴스 구성을 업데이트하기 위한 요청입니다. 중지된 인스턴스에서만 이 메서드를 사용할 수 있습니다.

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.updateShieldInstanceConfig
shielded_instance_config

ShieldedInstanceConfig

업데이트할 ShieldedInstance 구성입니다.

UpgradeInstanceRequest

노트북 인스턴스 업그레이드 요청

필드
name

string

필수 항목입니다. 형식: projects/{project_id}/locations/{location}/instances/{instance_id}

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

  • notebooks.instances.upgrade
type

UpgradeType

선택사항입니다. 선택적 UpgradeType입니다. 이 필드를 설정하면 이 인스턴스를 업그레이드할 추가 컴퓨팅 이미지를 검색합니다.

UpgradeType

이 인스턴스에서 사용할 수 있는 업그레이드 유형의 정의입니다.

열거형
UPGRADE_TYPE_UNSPECIFIED 업그레이드 유형이 지정되지 않았습니다.
UPGRADE_FRAMEWORK ML 프레임워크 업그레이드
UPGRADE_OS 운영체제 업그레이드
UPGRADE_CUDA CUDA를 업그레이드합니다.
UPGRADE_ALL 모두 업그레이드 (OS, 프레임워크, CUDA)

VirtualMachine

컴퓨팅을 위해 가상 머신을 사용하는 런타임입니다.

필드
instance_name

string

출력 전용입니다. 관리형 Compute Engine 인스턴스의 사용자 친화적인 이름입니다.
instance_id

string

출력 전용입니다. 관리 Compute Engine 인스턴스의 고유 식별자입니다.
virtual_machine_config

VirtualMachineConfig

가상 머신 구성 설정입니다.

VirtualMachineConfig

가상 머신의 구성 설정입니다.

필드
zone

string

출력 전용입니다. 가상 머신이 있는 영역입니다. 리전 요청을 사용하는 경우 Notebooks 서비스는 해당 런타임 리전의 위치를 선택합니다. get 요청에서는 항상 영역이 표시됩니다. 예: * us-central1-b
machine_type

string

필수 항목입니다. 런타임에 사용되는 Compute Engine 머신 유형입니다. 닉네임이 유효합니다. 예: * n1-standard-2 * e2-standard-8
container_images[]

ContainerImage

선택사항입니다. 노트북 인스턴스에서 커널로 사용할 컨테이너 이미지 목록을 사용합니다.
data_disk

LocalDisk

필수 항목입니다. 데이터 디스크 옵션 구성 설정입니다.
encryption_config

EncryptionConfig

선택사항입니다. 가상 머신 데이터 디스크의 암호화 설정입니다.
shielded_instance_config

RuntimeShieldedInstanceConfig

선택사항입니다. 보안 VM 인스턴스 구성 설정입니다.
accelerator_config

RuntimeAcceleratorConfig

선택사항입니다. 이 런타임의 Compute Engine 액셀러레이터 구성입니다.
network

string

선택사항입니다. 머신 통신에 사용될 Compute Engine 네트워크입니다. 서브네트워크와 함께 지정할 수 없습니다. network도 subnet도 지정되지 않은 경우 프로젝트의 'default' 네트워크가 사용됩니다(있는 경우).

전체 URL 또는 부분 URI입니다. 예:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
  • projects/[project_id]/global/networks/default

런타임은 Google 인프라 내에서 관리되는 리소스입니다. 런타임은 다음 네트워크 구성을 지원합니다.

  • Google 관리 네트워크 (네트워크 및 서브넷이 비어 있음)
  • 소비자 프로젝트 VPC (네트워크 및 서브넷이 필요함) 비공개 서비스 액세스를 구성해야 합니다.
  • 공유 VPC (네트워크 및 서브넷 필요) 비공개 서비스 액세스를 구성해야 합니다.
subnet

string

선택사항입니다. 머신 통신에 사용될 Compute Engine 서브네트워크입니다. 네트워크와 함께 지정할 수 없습니다.

전체 URL 또는 부분 URI가 유효합니다. 예:

  • https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
internal_ip_only

bool

선택사항입니다. true인 경우 런타임에 내부 IP 주소만 있습니다. 기본적으로 런타임은 내부 IP 주소로 제한되지 않으며 각 VM에 임시 외부 IP 주소가 할당됩니다. 이 internal_ip_only 제한은 서브네트워크 지원 네트워크에만 사용 설정할 수 있으며 모든 종속 항목은 외부 IP 주소 없이 액세스할 수 있도록 구성해야 합니다.
tags[]

string

선택사항입니다. 런타임에 추가할 Compute Engine 네트워크 태그입니다 (네트워크 태그 추가 참고).
guest_attributes

map<string, string>

출력 전용입니다. Compute Engine 게스트 속성입니다. (프로젝트 및 인스턴스 게스트 속성 참고)
metadata

map<string, string>

선택사항입니다. 가상 머신에 추가할 Compute Engine 메타데이터 항목입니다. 프로젝트 및 인스턴스 메타데이터 참고
labels

map<string, string>

선택사항입니다. 이 런타임과 연결할 라벨입니다. 라벨 키는 1~63자(영문 기준)여야 하며 RFC 1035를 준수해야 합니다. 라벨 값은 비어 있어도 되지만, 있는 경우 1~63자(영문 기준)여야 하며 RFC 1035를 준수해야 합니다. 클러스터와 연결할 수 있는 라벨은 32개 미만입니다.
nic_type

NicType

선택사항입니다. 이 인터페이스에서 사용할 vNIC 유형입니다. gVNIC 또는 VirtioNet일 수 있습니다.
reserved_ip_range

string

선택사항입니다. 예약된 IP 범위 이름은 VPC 피어링에 사용됩니다. 할당된 경우 서브네트워크 할당에 name 범위가 사용됩니다.

예: managed-notebooks-range-c

PEERING_RANGE_NAME_3=managed-notebooks-range-c
gcloud compute addresses create $PEERING_RANGE_NAME_3 \
  --global \
  --prefix-length=24 \
  --description="Google Cloud Managed Notebooks Range 24 c" \
  --network=$NETWORK \
  --addresses=192.168.0.0 \
  --purpose=VPC_PEERING

필드 값은 managed-notebooks-range-c입니다.
boot_image

BootImage

선택사항입니다. 런타임 업그레이드 가능성에 사용되는 부팅 이미지 메타데이터

BootImage

이 유형에는 필드가 없습니다.

런타임에서 사용하는 부팅 이미지의 정의입니다. 런타임 업그레이드 가능성을 촉진하는 데 사용됩니다.

NicType

vNIC 드라이버의 유형입니다. 기본값은 UNSPECIFIED_NIC_TYPE이어야 합니다.

열거형
UNSPECIFIED_NIC_TYPE 유형이 지정되지 않았습니다.
VIRTIO_NET VIRTIO
GVNIC gVNIC

VmImage

VM에 직접 설치된 환경으로 노트북 인스턴스를 시작하기 위한 맞춤 Compute Engine 가상 머신 이미지의 정의입니다.

필드
project

string

필수 항목입니다. 이 VM 이미지가 속한 Google Cloud 프로젝트의 이름입니다. 형식: {project_id}
통합 필드 image. 외부 Compute Engine VM 이미지를 참조합니다. image은 다음 중 하나여야 합니다.
image_name

string

VM 이미지 이름을 사용하여 이미지를 찾습니다.
image_family

string

이 VM 이미지 계열을 사용하여 이미지를 찾습니다. 이 계열의 최신 이미지가 사용됩니다.