Package google.cloud.notebooks.v2

색인

NotebookService

Workbench 노트북 인스턴스용 API v2 서비스입니다.

CheckInstanceUpgradability

rpc CheckInstanceUpgradability(CheckInstanceUpgradabilityRequest) returns (CheckInstanceUpgradabilityResponse)

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

승인 범위

다음 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를 참조하세요.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) 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를 참조하세요.
GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

다양한 구성 매개변수를 반환합니다.

승인 범위

다음 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를 참조하세요.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

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

승인 범위

다음 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를 참조하세요.
ResizeDisk

rpc ResizeDisk(ResizeDiskRequest) returns (Operation)

노트북 인스턴스 디스크의 크기를 더 큰 용량으로 조정합니다.

승인 범위

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

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

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

rpc RestoreInstance(RestoreInstanceRequest) returns (Operation)

RestoreInstance는 BackupSource에서 인스턴스를 복원합니다.

승인 범위

다음 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를 참조하세요.
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를 참조하세요.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

UpdateInstance는 인스턴스를 업데이트합니다.

승인 범위

다음 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를 참조하세요.

AcceleratorConfig

VM 인스턴스의 가속기 구성입니다. 하드웨어 가속기의 정의입니다. type 및 core_count 조합은 확인하지 않습니다. TPU는 지원되지 않습니다. 유효한 조합은 Compute Engine의 GPU를 참고하세요.

필드
type

AcceleratorType

선택사항입니다. 이 가속기의 유형입니다.
core_count

int64

선택사항입니다. 이 액셀러레이터의 코어 수입니다.

AcceleratorType

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

열거형
ACCELERATOR_TYPE_UNSPECIFIED 가속기 유형이 지정되지 않았습니다.
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_A100_80GB 가속기 유형은 Nvidia Tesla A100 - 80GB입니다.
NVIDIA_L4 가속기 유형은 Nvidia Tesla L4입니다.
NVIDIA_H100_80GB 가속기 유형은 Nvidia Tesla H100 - 80GB입니다.
NVIDIA_H100_MEGA_80GB 가속기 유형은 Nvidia Tesla H100 - MEGA 80GB입니다.
NVIDIA_H200_141GB 가속기 유형은 Nvidia Tesla H200 - 141GB입니다.
NVIDIA_TESLA_T4_VWS 가속기 유형은 NVIDIA Tesla T4 가상 워크스테이션입니다.
NVIDIA_TESLA_P100_VWS 가속기 유형은 NVIDIA Tesla P100 가상 워크스테이션입니다.
NVIDIA_TESLA_P4_VWS 가속기 유형은 NVIDIA Tesla P4 가상 워크스테이션입니다.
NVIDIA_B200 가속기 유형은 NVIDIA B200입니다.

AccessConfig

인스턴스의 네트워크 인터페이스에 연결된 액세스 구성입니다.

필드
external_ip

string

이 인스턴스에 연결된 외부 IP 주소입니다. 프로젝트에 사용할 수 있는 사용하지 않는 고정 외부 IP 주소를 지정하거나 이 필드를 정의되지 않은 상태로 두어 공유 임시 IP 주소 풀의 IP를 사용합니다. 고정 외부 IP 주소를 지정하는 경우 인스턴스의 영역과 동일한 리전에 있어야 합니다.

BootDisk

부팅 디스크의 정의입니다.

필드
disk_size_gb

int64

선택사항입니다. 이 인스턴스에 연결된 부팅 디스크의 크기(GB)입니다. 최대 64, 000GB(64TB)까지 가능합니다. 지정하지 않으면 권장 값인 150GB가 기본값으로 설정됩니다.
disk_type

DiskType

선택사항입니다. 디스크 유형을 나타냅니다.
disk_encryption

DiskEncryption

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

string

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

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

CheckInstanceUpgradabilityRequest

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

필드
notebook_instance

string

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

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

  • notebooks.instances.checkUpgradability

CheckInstanceUpgradabilityResponse

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

필드
upgradeable

bool

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

string

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

string

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

string

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

ConfidentialInstanceConfig

컨피덴셜 인스턴스 옵션 집합입니다.

필드
confidential_instance_type

ConfidentialInstanceType

선택사항입니다. 컨피덴셜 인스턴스에서 사용하는 기술 유형을 정의합니다.

ConfidentialInstanceType

컨피덴셜 인스턴스의 유형입니다.

열거형
CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED 유형이 지정되지 않았습니다. 이 값을 사용하지 마세요.
SEV AMD 보안 암호화 가상화

구성

위치에서 WbI 구성을 가져오기 위한 응답

필드
default_values

DefaultValues

출력 전용입니다. 구성의 기본값입니다.
supported_values

SupportedValues

출력 전용입니다. 구성의 지원되는 값입니다.
available_images[]

ImageRelease

출력 전용입니다. WbI를 만드는 데 사용할 수 있는 이미지 목록입니다.
disable_workbench_legacy_creation

bool

출력 전용입니다. 기존 Workbench 노트북 (사용자 관리 노트북 및 Google 관리 노트북)의 생성을 사용 중지하는 플래그입니다.

ContainerImage

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

필드
repository

string

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

string

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

CreateInstanceRequest

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

필드
parent

string

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

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

  • notebooks.instances.create
instance_id

string

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

Instance

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

string

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

DataDisk

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

필드
disk_size_gb

int64

선택사항입니다. 이 VM 인스턴스에 연결된 디스크의 크기(GB)입니다. 최대 64, 000GB(64TB)까지 가능합니다. 지정하지 않으면 기본값은 100입니다.
disk_type

DiskType

선택사항입니다. 입력 전용입니다. 디스크 유형을 나타냅니다.
disk_encryption

DiskEncryption

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

string

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

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

string

선택사항입니다. 데이터 디스크에 적용할 리소스 정책입니다.

DefaultValues

DefaultValues는 기본 구성 값을 나타냅니다.

필드
machine_type

string

출력 전용입니다. 사용자가 제공하지 않는 경우 백엔드에서 사용하는 기본 머신 유형입니다.

DeleteInstanceRequest

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

필드
name

string

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

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

  • notebooks.instances.delete
request_id

string

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

DiagnoseInstanceRequest

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

필드
name

string

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

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

  • notebooks.instances.diagnose
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/
enable_repair_flag

bool

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

bool

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

bool

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

DiskEncryption

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

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

DiskType

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

열거형
DISK_TYPE_UNSPECIFIED 디스크 유형이 설정되지 않았습니다.
PD_STANDARD 표준 영구 디스크 유형입니다.
PD_SSD SSD 영구 디스크 유형입니다.
PD_BALANCED 균형 있는 영구 디스크 유형입니다.
PD_EXTREME 익스트림 영구 디스크 유형입니다.
HYPERDISK_BALANCED Hyperdisk Balanced 영구 디스크 유형을 나타냅니다. 부팅 디스크 또는 데이터 디스크로 사용할 수 있습니다.
HYPERDISK_EXTREME Hyperdisk Extreme 영구 디스크 유형을 나타냅니다. 데이터 디스크로만 사용할 수 있습니다.
HYPERDISK_THROUGHPUT Hyperdisk Throughput 영구 디스크 유형을 나타냅니다. 데이터 디스크로만 사용할 수 있습니다.
HYPERDISK_BALANCED_HIGH_AVAILABILITY Hyperdisk Balanced High Availability 영구 디스크 유형을 나타냅니다. 부팅 디스크 또는 데이터 디스크로 사용할 수 있습니다.
HYPERDISK_ML Hyperdisk ML 영구 디스크 유형을 나타냅니다. 부팅 디스크 또는 데이터 디스크로 사용할 수 있습니다.

GPUDriverConfig

GPU 드라이버 구성

필드
enable_gpu_driver

bool

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

string

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

GceSetup

리소스 및 ID 외부에서 VM 인스턴스를 구성하는 방법에 관한 정의입니다.

필드
machine_type

string

선택사항입니다. VM 인스턴스의 머신 유형입니다. https://cloud.google.com/compute/docs/machine-resource
min_cpu_platform

string

선택사항입니다. 이 인스턴스에 사용할 최소 CPU 플랫폼입니다. 유효한 값 목록은 https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones에서 확인할 수 있습니다.
accelerator_configs[]

AcceleratorConfig

선택사항입니다. 이 인스턴스에서 사용되는 하드웨어 가속기입니다. 가속기를 사용하는 경우 구성에 선택한 machine_type를 지원할 수 있는 충분한 vCPU와 메모리가 있는지 확인하세요. 현재는 하나의 액셀러레이터 구성만 지원합니다.
service_accounts[]

ServiceAccount

선택사항입니다. VM 인스턴스의 ID로 사용되는 서비스 계정입니다. 현재 하나의 서비스 계정만 지원합니다.
boot_disk

BootDisk

선택사항입니다. VM의 부팅 디스크입니다.
data_disks[]

DataDisk

선택사항입니다. VM 인스턴스에 연결된 데이터 디스크입니다. 현재는 데이터 디스크 하나만 지원됩니다.
shielded_instance_config

ShieldedInstanceConfig

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

NetworkInterface

선택사항입니다. VM의 네트워크 인터페이스입니다. 인터페이스 하나만 지원됩니다.
disable_public_ip

bool

선택사항입니다. true인 경우 이 VM 인스턴스에 외부 IP가 할당되지 않습니다.
tags[]

string

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

map<string, string>

선택사항입니다. 이 인스턴스에 적용할 커스텀 메타데이터입니다.
enable_ip_forwarding

bool

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

GPUDriverConfig

선택사항입니다. GPU 드라이버 구성
confidential_instance_config

ConfidentialInstanceConfig

선택사항입니다. 컨피덴셜 인스턴스 구성입니다.
instance_id

string

출력 전용입니다. Compute Engine 인스턴스 리소스의 고유 ID입니다.
통합 필드 image. 이미지 유형입니다. VM 이미지 또는 컨테이너 이미지 중 하나일 수 있습니다. image은 다음 중 하나여야 합니다.
vm_image

VmImage

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

ContainerImage

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

GetConfigRequest

Workbench 구성 매개변수를 가져오기 위한 요청입니다.

필드
name

string

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

GetInstanceRequest

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

필드
name

string

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

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

  • notebooks.instances.get

HealthState

인스턴스 상태입니다.

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

ImageRelease

ConfigImage는 WbI를 만드는 데 사용할 수 있는 이미지 출시 버전을 나타냅니다.

필드
image_name

string

출력 전용입니다. workbench-instances-vYYYYmmdd-- 형식의 이미지 이름
release_name

string

출력 전용입니다. m123 양식의 이미지 출시

인스턴스

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

필드
name

string

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

string

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

string

선택사항입니다. 생성 후 이 인스턴스의 소유자입니다. 형식: alias@example.com

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

string

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

State

출력 전용입니다. 이 인스턴스의 상태입니다.
upgrade_history[]

UpgradeHistoryEntry

출력 전용입니다. 이 인스턴스의 업그레이드 내역입니다.
id

string

출력 전용입니다. 리소스의 고유 ID입니다.
health_state

HealthState

출력 전용입니다. 인스턴스 health_state입니다.
health_info

map<string, string>

출력 전용입니다. 인스턴스 상태에 대한 추가 정보입니다. 예:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}
create_time

Timestamp

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

Timestamp

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

bool

선택사항입니다. true인 경우 노트북 인스턴스가 프록시에 등록되지 않습니다.
labels

map<string, string>

선택사항입니다. 이 인스턴스에 적용할 라벨입니다. 나중에 UpdateInstance 메서드로 수정할 수 있습니다.
third_party_proxy_url

string

출력 전용입니다. Jupyter 노트북에 액세스하는 데 사용되는 직원 풀 프록시 엔드포인트입니다.
satisfies_pzs

bool

출력 전용입니다. 영역 분리를 위해 나중에 사용하도록 예약되어 있습니다.
satisfies_pzi

bool

출력 전용입니다. 영역 격리를 위해 나중에 사용하도록 예약되어 있습니다.
enable_third_party_identity

bool

선택사항입니다. 서드 파티 ID 공급업체로 노트북에 액세스할 수 있음을 지정하는 플래그입니다.
enable_managed_euc

bool

선택사항입니다. 인스턴스에 관리형 최종 사용자 인증 정보를 사용 설정하는 플래그입니다.
enable_deletion_protection

bool

선택사항입니다. true인 경우 이 워크벤치 인스턴스에 삭제 방지가 사용 설정됩니다. false인 경우 이 워크벤치 인스턴스의 삭제 방지가 사용 중지됩니다.
통합 필드 infrastructure. 노트북 인스턴스 설정입니다. infrastructure은 다음 중 하나여야 합니다.
gce_setup

GceSetup

선택사항입니다. 노트북의 Compute Engine 설정입니다. 노트북 정의 필드를 사용합니다.

ListInstancesRequest

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

필드
parent

string

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

승인을 처리하려면 지정된 리소스 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

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

NetworkInterface

VM에 연결된 네트워크 인터페이스 리소스의 정의입니다.

필드
network

string

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

string

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

NicType

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

AccessConfig

선택사항입니다. 이 인터페이스의 구성 배열입니다. 현재는 액세스 구성인 ONE_TO_ONE_NAT만 지원됩니다. accessConfigs가 지정되지 않은 경우 인스턴스는 임시 외부 IP 주소를 통해 외부 인터넷에 액세스할 수 있습니다.

NicType

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

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

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 엔드포인트 이름입니다.

ResetInstanceRequest

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

필드
name

string

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

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

  • notebooks.instances.reset

ResizeDiskRequest

노트북 인스턴스 디스크 크기 조절 요청

필드
notebook_instance

string

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

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

  • notebooks.instances.update
통합 필드 Disk. 크기를 조절할 수 있는 디스크 유형(부팅 또는 데이터 디스크) Disk은 다음 중 하나여야 합니다.
boot_disk

BootDisk

필수 항목입니다. 크기를 조절할 부팅 디스크입니다. disk_size_gb만 사용됩니다.
data_disk

DataDisk

필수 항목입니다. 크기를 조절할 데이터 디스크입니다. disk_size_gb만 사용됩니다.

RestoreInstanceRequest

BackupSource에서 노트북 인스턴스를 복원하기 위한 요청입니다.

필드
name

string

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

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

  • notebooks.instances.update
통합 필드 Source. 복원할 소스입니다. Source은 다음 중 하나여야 합니다.
snapshot

Snapshot

복원에 사용할 스냅샷입니다.

RollbackInstanceRequest

노트북 인스턴스 롤백 요청

필드
name

string

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

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

  • notebooks.instances.rollback
target_snapshot

string

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

string

필수 항목입니다. 출력 전용입니다. 버전 ID

ServiceAccount

ID 역할을 하는 서비스 계정입니다.

필드
email

string

선택사항입니다. 서비스 계정의 이메일 주소
scopes[]

string

출력 전용입니다. 이 서비스 계정에 사용할 수 있도록 할 범위 목록입니다. CLH에 의해 https://www.googleapis.com/auth/cloud-platform으로 설정됩니다.

ShieldedInstanceConfig

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

필드
enable_secure_boot

bool

선택사항입니다. VM 인스턴스에 보안 부팅이 사용 설정되어 있는지 정의합니다.

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

bool

선택사항입니다. VM 인스턴스에 vTPM이 사용 설정되어 있는지 여부를 정의합니다.
enable_integrity_monitoring

bool

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

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

스냅샷

스냅샷은 워크벤치 인스턴스를 복원하는 데 사용되는 데이터 디스크의 스냅샷을 나타냅니다. compute/v1/projects/{project_id}/global/snapshots/{snapshot_id}를 참조합니다.

필드
snapshot_id

string

필수 항목입니다. 스냅샷의 ID입니다.
project_id

string

필수 항목입니다. 스냅샷의 프로젝트 ID입니다.

StartInstanceRequest

노트북 인스턴스 시작 요청

필드
name

string

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

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

  • notebooks.instances.start

주

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

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

StopInstanceRequest

노트북 인스턴스 중지 요청

필드
name

string

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

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

  • notebooks.instances.stop

SupportedValues

SupportedValues는 구성에서 지원하는 값을 나타냅니다.

필드
machine_types[]

string

출력 전용입니다. WbI에서 지원하는 머신 유형입니다.
accelerator_types[]

string

출력 전용입니다. WbI에서 지원하는 가속기 유형입니다.

UpdateInstanceRequest

노트북 인스턴스 업데이트 요청입니다.

필드
instance

Instance

필수 항목입니다. 인스턴스의 표현입니다.

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

  • iam.permissions.none
update_mask

FieldMask

필수 항목입니다. 인스턴스를 업데이트하는 데 사용되는 마스크입니다. 업데이트 가능한 필드:

  • labels
  • gce_setup.min_cpu_platform
  • gce_setup.metadata
  • gce_setup.machine_type
  • gce_setup.accelerator_configs
  • gce_setup.accelerator_configs.type
  • gce_setup.accelerator_configs.core_count
  • gce_setup.gpu_driver_config
  • gce_setup.gpu_driver_config.enable_gpu_driver
  • gce_setup.gpu_driver_config.custom_gpu_driver_path
  • gce_setup.shielded_instance_config
  • gce_setup.shielded_instance_config.enable_secure_boot
  • gce_setup.shielded_instance_config.enable_vtpm
  • gce_setup.shielded_instance_config.enable_integrity_monitoring
  • gce_setup.reservation_affinity
  • gce_setup.reservation_affinity.consume_reservation_type
  • gce_setup.reservation_affinity.key
  • gce_setup.reservation_affinity.values
  • gce_setup.tags
  • gce_setup.container_image
  • gce_setup.container_image.repository
  • gce_setup.container_image.tag
  • gce_setup.disable_public_ip
  • disable_proxy_access
request_id

string

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

UpgradeHistoryEntry

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

필드
snapshot

string

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

string

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

string

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

string

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

string

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

State

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

Timestamp

변경할 수 없습니다. 이 인스턴스 업그레이드 기록 항목이 생성된 시간입니다.
action

Action

선택사항입니다. 작업입니다. 롤백 또는 업그레이드
target_version

string

선택사항입니다. 타겟 VM 버전(예: m63)입니다.

작업

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

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

주

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

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

UpgradeInstanceRequest

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

필드
name

string

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

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

  • notebooks.instances.upgrade

VmImage

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

필드
project

string

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

string

선택사항입니다. VM 이미지 이름을 사용하여 이미지를 찾습니다.
family

string

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