Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ ModelArts/ Referencia de la API/ DevEnviron (Recomendado)/ Gestión de instancias de DevEnviron/ Consulta de detalles de una instancia de notebook

Actualización más reciente 2022-11-14 GMT+08:00

Ver PDF

Consulta de detalles de una instancia de notebook

Función

Esta API se utiliza para consultar detalles sobre una instancia de notebook, incluidos su ID, nombre, variante, imagen, estado y URL accesibles.

Restricciones

No hay

URI

GET /v1/{project_id}/notebooks/{id}

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
id	Sí	String	ID de instancia del notebook.
project_id	Sí	String	ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto.

Parámetros de solicitud

No hay

Parámetros de respuesta

Código de estado: 200

**Tabla 2** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
action_progress	Array of JobProgress objects	Progreso de inicialización de instancia.
description	String	Descripción de la instancia
endpoints	Array of EndpointsRes objects	IDE local (como PyCharm y vsCode) o cliente SSH para acceder remotamente a una instancia de notebook a través de SSH.
fail_reason	String	Causa de error de instancia
feature	String	Tipo de instancia. Opciones: DEFAULT: instancia CodeLab gratuita. Solo puede crear uno. NOTEBOOK: instancia facturada.
flavor	String	Variante de la instancia
id	String	ID de la instancia
image	Image object	Imagen de instancia
lease	Lease object	Cuenta atrás para detener la instancia automática.
name	String	Nombre de la instancia
pool	Pool object	Información básica sobre el grupo dedicado, que es devuelto por la instancia creada en el grupo dedicado.
status	String	Opciones de estado de instancia: INIT: Se está inicializando la instancia. CREATING: Se está creando la instancia. STARTING: La instancia se está iniciando. STOPPING: La instancia se está deteniendo. DELETING: se está eliminando la instancia. RUNNING: La instancia se está ejecutando. STOPPED: La instancia se detiene. SNAPSHOTTING: Se está tomando una instantánea para la instancia (estado cuando se guarda la imagen). CREATE_FAILED: Error al crear la instancia. START_FAILED: Error al iniciar la instancia. DELETE_FAILED: Error al eliminar la instancia. ERROR: Se ha producido un error. DELETED: Se ha eliminado la instancia. FROZEN: La instancia está congelada.
token	String	Token utilizado para la autenticación del notebook
url	String	URL para acceder a la instancia del notebook
volume	VolumeRes object	Volumen de almacenamiento
workspace_id	String	ID del espacio de trabajo. Si no hay espacios de trabajo disponibles, el valor predeterminado es 0.

**Tabla 3** JobProgress
Parámetro	Tipo	Descripción
notebook_id	String	ID de la instancia
status	String	Estado del trabajo en un paso especificado. Opciones: WAITING: El trabajo está esperando para comenzar. PROCESSING: El trabajo se está procesando. FAILED: El trabajo falló. COMPLETED: La tarea está completa.
step	Integer	Paso de trabajo. Opciones: 1: Preparación de almacenamiento. 2: Preparación de recursos informáticos. 3: Configuraciones de red. 4: Inicialización de instancia.
step_description	String	Descripción de un paso en un trabajo.

**Tabla 4** EndpointsRes
Parámetro	Tipo	Descripción
allowed_access_ips	Array of strings	Lista blanca de direcciones IP públicas a las que se les permite acceder a la instancia del cuaderno a través de SSH. De forma predeterminada, todas las direcciones IP públicas pueden acceder a la instancia de notebook. Si se especifica este parámetro, sólo los clientes con las direcciones IP especificadas pueden acceder a la instancia del notebook.
dev_service	String	Servicios soportados. Opciones: NOTEBOOK: Puede acceder a la instancia del notebook mediante HTTPS. SSH: Puede acceder remotamente a la instancia del cuaderno a través de SSH.
ssh_keys	Array of strings	Lista de pares de claves SSH. Puede establecer varios pares de claves para acceder a una instancia SSH al mismo tiempo.

**Tabla 5** Image
Parámetro	Tipo	Descripción
id	String	ID de imagen
name	String	Nombre de la imagen.
swr_path	String	Dirección de imagen SWR
type	String	Tipo de imagen. Opciones: BUILD_IN: imagen integrada del sistema DEDICATED: imagen guardada por el usuario

**Tabla 6** Lease
Parámetro	Tipo	Descripción
create_at	Long	Hora (UTC) en la que se crea la instancia, con una precisión de milisegundos.
duration	Long	Duración de ejecución de la instancia, que se calcula en función del tiempo de creación de la instancia. Si el tiempo de creación de la instancia más la duración es mayor que el tiempo actual, el sistema detiene automáticamente la instancia.
enable	Boolean	Si se activa la detención automática de la instancia.
update_at	Long	Tiempo (UTC) cuando la instancia se actualiza por última vez (excluyendo el tiempo de latido del corazón de keepalive), exacto a milisegundos.

**Tabla 7** Pool
Parámetro	Tipo	Descripción
id	String	ID de un fondo de recursos dedicado
name	String	Nombre de un fondo de recursos dedicado

**Tabla 8** VolumeRes
Parámetro	Tipo	Descripción
capacity	Integer	Capacidad de almacenamiento. El valor predeterminado es 5 GB para EVS y 50 GB para EFS. El valor máximo es de 4,096 GB.
category	String	Tipo de almacenamiento. Se admite el almacenamiento EVS.
mount_path	String	Directorio de la instancia de notebook en la que está montado el almacenamiento OBS. Actualmente, el directorio es /home/ma-user/work/.
ownership	String	Propietario al que pertenece el recurso. Opciones: MANAGED: Los recursos son gestionados por servicios. DEDICATED: Los recursos son administrados por la cuenta de usuario. Este modo sólo se admite cuando la categoría de instancia es EFS.
status	String	Estado de expansión de la capacidad del disco EVS, que es RESIZING durante la expansión de la capacidad y no afecta a la instancia.

Ejemplo de las solicitudes

No hay

Ejemplo de las respuestas

Código de estado: 200

{
  "create_at" : 1638778344314,
  "description" : "api-test",
  "endpoints" : [ {
    "service" : "NOTEBOOK",
    "uri" : "https://authoring-modelarts-cnnorth7.ulanqab.huawei.com/f9937afa-631e-4a8f-a8f7-3b6c800585f0/lab"
  } ],
  "feature" : "NOTEBOOK",
  "flavor" : "modelarts.vm.cpu.2u",
  "id" : "f9937afa-631e-4a8f-a8f7-3b6c800585f0",
  "image" : {
    "arch" : "X86_64",
    "currentTag" : "3.3.1.B007_V2",
    "feature" : "DEFAULT",
    "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
    "name" : "notebook2.0-mul-kernel-cpu-cp36",
    "swr_path" : "swr.cn-north-7.myhuaweicloud.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.1.B007_V2",
    "type" : "BUILD_IN"
  },
  "lease" : {
    "create_at" : 1638778344300,
    "duration" : 3600000,
    "enable" : true,
    "update_at" : 1638778344300
  },
  "name" : "notebooks_test",
  "status" : "CREATE_FAILED",
  "token" : "7b22482a-a4cb-4b46-e3b3-6a793a47967e",
  "update_at" : 1638778346131,
  "url" : "https://authoring-modelarts-cnnorth7.ulanqab.huawei.com/f9937afa-631e-4a8f-a8f7-3b6c800585f0/lab",
  "workspace_id" : "0"
}