Consulta de Instancias de Notebook
Función
Esta API se utiliza para consultar instancias de notebook según criterios de búsqueda especificados.
Restricciones
No hay
URI
GET /v1/{project_id}/notebooks
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
feature |
No |
String |
Tipo de instancia. El valor predeterminado es NOTEBOOK. Opciones:
|
limit |
No |
Integer |
Número de registros en cada página. |
name |
No |
String |
Nombre de instancia, que contiene un máximo de 128 caracteres y puede consistir en letras mayúsculas y minúsculas, dígitos, guiones (-) y guiones bajos (_). Se admite la coincidencia difusa. |
offset |
No |
Integer |
Desplazamiento inicial de los registros de cada página. |
owner |
No |
String |
ID de usuario de la instancia, que contiene 32 caracteres, incluidas letras minúsculas y dígitos. Este parámetro es válido solo cuando la cuenta es una cuenta grande o tiene el permiso de admin. Generalmente, el valor es el ID del usuario de inicio de sesión actual. |
sort_dir |
No |
String |
Orden de clasificación. Las opciones son ASC (orden ascendente) y DESC (orden descendente). |
sort_key |
No |
String |
Ordenando campos. Separar varios campos con comas (,). |
status |
No |
String |
Estado de la instancia. Opciones:
|
workspaceId |
No |
String |
ID del espacio de trabajo. Si no hay espacios de trabajo disponibles, el valor predeterminado es 0. |
Parámetros de solicitud
No hay
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
current |
Integer |
Página actual |
data |
Array of NotebookResp objects |
Datos |
pages |
Integer |
Páginas totales |
size |
Integer |
Número de registros en cada página |
total |
Long |
Registros totales |
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:
|
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:
|
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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
notebook_id |
String |
ID de la instancia |
status |
String |
Estado del trabajo en un paso especificado. Opciones:
|
step |
Integer |
Paso de trabajo. Opciones:
|
step_description |
String |
Descripción de un paso en un trabajo. |
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:
|
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. |
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:
|
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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de un fondo de recursos dedicado |
name |
String |
Nombre de un fondo de recursos dedicado |
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:
|
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
OK
{ "current" : 0, "data" : [ { "create_at" : 1638841805440, "data_volumes" : [ ], "endpoints" : [ { "service" : "NOTEBOOK", "uri" : "https://authoring-modelarts-cnnorth7.ulanqab.huawei.com/f9937afa-ca78-45b6-bc12-7ecf42553c48/lab" } ], "feature" : "DEFAULT", "flavor" : "modelarts.vm.cpu.free", "id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48", "image" : { "description" : "description", "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.2-release_v1", "tag" : "3.3.2-release_v1", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841805439, "duration" : 3600000, "enable" : true, "update_at" : 1638841805439 }, "name" : "notebook_5ee4bf0e", "status" : "RUNNING", "token" : "58ba50c6-e8ff-245c-4840-49e51aa70737", "update_at" : 1638841838725, "url" : "https://authoring-modelarts-cnnorth7.ulanqab.huawei.com/f9937afa-ca78-45b6-bc12-7ecf42553c48/lab", "volume" : { "category" : "EVS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50, "usage" : -1 }, "workspace_id" : "0" }, { "create_at" : 1638841744521, "data_volumes" : [ ], "description" : "api-test", "endpoints" : [ { "service" : "NOTEBOOK", "uri" : "https://authoring-modelarts-cnnorth7.ulanqab.huawei.com/f9937afa-4451-42db-a76b-72d624749f66/lab" } ], "feature" : "NOTEBOOK", "flavor" : "modelarts.vm.cpu.2u", "id" : "f9937afa-4451-42db-a76b-72d624749f66", "image" : { "description" : "description", "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.2-release_v1", "tag" : "3.3.2-release_v1", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841744515, "duration" : 3600000, "enable" : true, "update_at" : 1638841744515 }, "name" : "notebooks_test", "status" : "RUNNING", "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022", "update_at" : 1638841776582, "url" : "https://authoring-modelarts-cnnorth7.ulanqab.huawei.com/f9937afa-4451-42db-a76b-72d624749f66/lab", "volume" : { "category" : "EVS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50, "usage" : -1 }, "workspace_id" : "0" } ], "pages" : 1, "size" : 10, "total" : 2 }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Aceptar |
401 |
Sin autorización |
403 |
Prohibido |
404 |
No se ha encontrado |
Códigos de error
Consulte Códigos de error.