# 查询Notebook实例列表 - ListNotebooks #### 功能介绍 查询Notebook实例列表接口用于获取满足特定条件的Notebook实例信息。该接口适用于以下场景：用户管理多个Notebook实例或查看特定状态的Notebook实例时，可通过此接口获取相关信息。使用该接口的前提条件是用户已创建Notebook实例，并且具有相应的查询权限。调用成功后，系统将返回符合条件的Notebook实例列表，包含实例ID、状态、创建时间等详细信息。若用户无权限访问或查询条件不明确，接口将返回相应的错误信息或空列表。 #### 接口约束 暂无约束。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListNotebooks)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:notebook:list | List | notebook \* | - | - | - | | modelarts:notebook:list | List | - | - g:EnterpriseProjectId - g:RequestTag/\ - g:TagKeys | - | - | #### URI GET /v1/{project_id}/notebooks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID，获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | feature | 否 | String | **参数解释**：实例类别。 **约束限制**：不涉及。 **取值范围**：枚举类型，取值如下： - DEFAULT：CodeLab免费规格实例，每个用户最多只能创建一个。 - NOTEBOOK：计费规格实例。 **默认取值**：NOTEBOOK。 | | limit | 否 | Integer | **参数解释**：每一页显示实例的数量。 **约束限制**：不涉及。 **取值范围**：\[10,20,50\]。 **默认取值**：10。 | | name | 否 | String | **参数解释**：实例名称，支持模糊匹配查询。 **约束限制**：不涉及。 **取值范围**：长度限制128个字符，支持大小写字母、数字、中划线和下划线。 **默认取值**：不涉及。 | | pool_id | 否 | String | **参数解释**：专属资源池ID。 **约束限制**：不涉及。 **取值范围**：长度最长为64个字符，最短为4个字符，支持小写字母、数字、中划线，且必须是小写字母开头，小写字母或数字结尾。 **默认取值**：不涉及。 | | offset | 否 | Integer | **参数解释**：分页记录的起始位置偏移量。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：0。 | | owner | 否 | String | **参数解释**：实例归属的用户ID，在大账号/有admin权限场景下生效，值通常为当前登录用户ID。 **约束限制**：不涉及。 **取值范围**：长度为32位小写字母、数字。 **默认取值**：不涉及。 | | sort_dir | 否 | String | **参数解释**：实例排序方式。 **约束限制**：不涉及。 **取值范围**：枚举类型，取值如下： - ASC：升序 - DESC：降序 **默认取值**：DESC。 | | sort_key | 否 | String | **参数解释**：排序的字段，多个字段使用(",")逗号分隔。 **约束限制**：不涉及。 **取值范围**：长度限制为128个字符，支持大小写字母、数字、中划线、下划线和逗号。 **默认取值**：不涉及。 | | status | 否 | String | **参数解释**：实例状态。 **约束限制**：不涉及。 **取值范围**：枚举类型，取值如下： - INIT：初始化 - CREATING：创建中 - STARTING：启动中 - STOPPING：停止中 - DELETING：删除中 - RUNNING：运行中 - STOPPED：已停止 - SNAPSHOTTING：快照中(保存镜像时的状态) - CREATE_FAILED：创建失败 - START_FAILED：启动失败 - DELETE_FAILED：删除失败 - ERROR：错误 - DELETED：已删除 - FROZEN：冻结 **默认取值**：不涉及。 | | workspace_id | 否 | String | **参数解释** ：工作空间ID。获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002723741766)。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：0。 | | flavor | 否 | String | **参数解释**：实例的机器规格编码，支持模糊匹配查询。如下规格仅供参考，实际支持的规格以具体区域为准。 modelarts.vm.cpu.2u：Intel CPU通用规格，用于快速数据探索和实验。 modelarts.vm.cpu.8u：Intel CPU算力增强型，适用于密集计算场景下运算。 **约束限制**：不支持专属资源池的自定义规格查询。 **取值范围**：长度限制1-256字符，支持数字、大小写字母、小数点、下划线或中划线。 **默认取值**：不涉及。 | | image_id | 否 | String | **参数解释** ：待创建Notebook实例的镜像，需要指定镜像ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。镜像的ID可通过调用[查询支持的镜像列表](https://support.huaweicloud.com/api-modelarts/ListImage.html)接口获取。 **约束限制**：不涉及。 **取值范围** ：调用[查询支持的镜像列表](https://support.huaweicloud.com/api-modelarts/ListImage.html)接口获取的合法镜像ID列表。 **默认取值**：不涉及。 | | id | 否 | String | **参数解释** ：Notebook实例ID。ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID），可通过调用[查询Notebook实例列表接口](https://support.huaweicloud.com/api-modelarts/ListNotebooks.html#section0)获取。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | billing | 否 | String | **参数解释**：实例计费类型。 **约束限制**：不涉及。 **取值范围**：枚举类型，取值如下： - COMPUTE：计算资源计费 - STORAGE：存储资源计费 - ALL：所有计费类型 **默认取值**：不涉及。 | | tags | 否 | String | **参数解释**：实例标签信息。 **约束限制**：不涉及。 **取值范围**：不以逗号，竖划线开头，不以逗号结尾，不出现连续的竖划线和逗号，允许中文、西文、葡文等语言以及空格_.:/=+-@特殊字符，且字符间以逗号或者竖划线分割。例：tag_key1\|tag_value1,tag_key2\|tag_value2。 **默认取值**：不涉及。 | | swr_path | 否 | String | **参数解释**：SWR镜像路径，该参数是针对返回参数NotebookResp中Image的swr_path属性进行模糊匹配查询。 **约束限制**：不涉及。 **取值范围**：长度限制2048个字符，支持数字、大小写字母、下划线、中划线、点号、冒号和斜杠，0-2048个字符。 **默认取值**：不涉及。 | | pool_name | 否 | String | **参数解释**：专属资源池名称，支持模糊匹配查询。 **约束限制**：不涉及。 **取值范围**：长度限制1-64字符，支持数字、大小写字母和中划线。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：实例描述信息，支持模糊匹配查询。 **约束限制**：不涉及。 **取值范围**：长度限制为512字符，不可包含特殊字符\<\>。 **默认取值**：不涉及。 | | ip | 否 | String | **参数解释**：节点IP。 **约束限制**：不涉及。 **取值范围**：正确的IPv4地址，暂不支持IPv6地址。 **默认取值**：不涉及。 | | username | 否 | String | **参数解释**：实例创建用户名称，支持模糊匹配查询。 **约束限制**：不涉及。 **取值范围**：长度限制1-256字符，支持数字、大小写字母、小数点、下划线或中划线。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current | Integer | **参数解释**：当前页数。 **取值范围**：正整数。 | | data | Array of [NotebookResp] objects | **参数解释**：Notebook实例数据。 | | pages | Integer | **参数解释**：总的页数。 **取值范围**：正整数。 | | size | Integer | **参数解释**：每一页的数量。 **取值范围**：正整数。 | | total | Long | **参数解释**：总的记录数量。 **取值范围**：非负整数。 | 表4NotebookResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action_progress | Array of [JobProgress] objects | **参数解释**：实例初始化进度。 | | description | String | **参数解释**：实例描述。 **取值范围**：不涉及。 | | endpoints | Array of [EndpointsRes] objects | **参数解释**：本地IDE（如PyCharm、VS Code）或SSH客户端，通过SSH远程接入Notebook实例时需要的相关配置。 | | fail_reason | String | **参数解释**：实例失败原因。 **取值范围**：不涉及。 | | flavor | String | **参数解释**：实例规格， 1.当用户选择系统规格时，返回值为系统规格码； 2.当用户创建实例时选择了自定义规格，则此字段会固定返回"custom.flavor.spec.code"。 **取值范围**：不涉及。 | | custom_spec | [NotebookCustomSpecRep] object | **参数解释**：实例自定义规格详情，仅CPU/GPU专属池，用户自定义规格时返回。 **取值范围**：不涉及 | | id | String | **参数解释**：实例ID。 **取值范围**：不涉及。 | | image | [Image] object | **参数解释**：实例镜像信息。 | | lease | [Lease] object | **参数解释**：实例自动停止的倒计时信息。 | | name | String | **参数解释**：实例名称。 **取值范围**：不涉及。 | | pool | [Pool] object | **参数解释**：专属池的基本信息，在专属池中创建的实例会返回该字段。 | | status | String | **参数解释**：实例状态。 **取值范围**：枚举类型，取值如下： - INIT：初始化 - CREATING：创建中 - STARTING：启动中 - STOPPING：停止中 - DELETING：删除中 - RUNNING：运行中 - STOPPED：已停止 - SNAPSHOTTING：快照中(保存镜像时的状态) - CREATE_FAILED：创建失败 - START_FAILED：启动失败 - DELETE_FAILED：删除失败 - ERROR：错误 - DELETED：已删除 - FROZEN：冻结 | | token | String | **参数解释**：Notebook鉴权使用的token信息。 **取值范围**：不涉及。 | | url | String | **参数解释**：实例访问的URL。 **取值范围**：不涉及。 | | volume | [VolumeRes] object | **参数解释**：实例存储信息。 | | workspace_id | String | **参数解释**：工作空间ID。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **取值范围**：不涉及。 | | feature | String | **参数解释**：实例类别。 **取值范围**：枚举类型，取值如下： - DEFAULT：CodeLab免费规格实例，每个用户最多只能创建一个。 - NOTEBOOK：计费规格实例。 | | billing_items | Array of strings | **参数解释**：计费资源类型。枚举类型，取值如下： - STORAGE：存储资源计费。 - COMPUTE：计算资源计费。 - ALL：所有计费类型。 | | user | [UserResponse] object | **参数解释**：账号信息。 | | affinity | [AffinityType] object | **参数解释**：亲和度信息 | | run_user | [RunUserInfo] object | **参数解释**：启动用户、启动用户组信息 | | data_volumes | Array of [VolumeResponse] objects | **参数解释**：扩展存储信息 | | ip | String | **参数解释**：实例所在节点ip。 **取值范围**：不涉及。 | | user_vpc | [UserVpcResponse] object | **参数解释**：用户VPC配置信息。 | | user_id | String | **参数解释**：用户ID。 **取值范围**：不涉及。 | | is_need_credentials | Boolean | **参数解释**：是否需要默认创建用户secret，默认为true。 **取值范围**：不涉及。 | | jupyter_version | String | **参数解释**：jupyter version版本号。 **取值范围**：不涉及。 | | tags | Array of [TmsTagResponse] objects | **参数解释**：实例标签。 | 表5JobProgress | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**：任务某个步骤的状态。 **取值范围**：枚举类型，取值如下： - WAITING：等待中 - PROCESSING：处理中 - FAILED：任务失败 - COMPLETED：任务完成 | | step | Integer | **参数解释**：任务的步骤。 **取值范围**：枚举类型，取值如下： - 1：准备存储 - 2：准备计算资源 - 3：配置网络 - 4：初始化实例 | | description | String | **参数解释**：任务某个步骤的描述。 **取值范围**：不涉及。 | 表6EndpointsRes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_pair_names | Array of strings | **参数解释**：SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。 **取值范围**：不涉及。 | | service | String | **参数解释**：访问Notebook的途径。 **取值范围**：枚举类型，取值如下： - NOTEBOOK：可以通过https协议访问Notebook。 - SSH：可以通过SSH协议远程连接Notebook。 | | uri | String | **参数解释**：实例私有IP地址。 **取值范围**：不涉及。 | | dev_service | String | **参数解释**：访问Notebook的途径。 **取值范围**：枚举类型，取值如下： - NOTEBOOK：可以通过https协议访问Notebook。 - SSH：可以通过SSH协议远程连接Notebook。 | 表7NotebookCustomSpecRep | 参数 | 参数类型 | 描述 | |:---|:---|:---| | gpu | Float | **参数描述**：实例申请的GPU卡数。 **取值范围**：不涉及。 | | gpu_type | String | **参数描述**：实例申请的GPU加速卡类型。 **取值范围**：不涉及。 | | cpu | Float | **参数描述**：实例申请的CPU核数大小。 **取值范围**：整数部分最多10位，小数部分最多2位，且数值不得小于0.4。 | | memory | Float | **参数描述**：实例申请的内存大小。 **取值范围**：必须是整数，整数部分最多10位，且数值不得小于513。 | | arch | String | **参数描述**：实例申请的CPU架构。 **取值范围**：枚举类型，取值如下： - X86_64：x86架构 - AARCH64：ARM架构 | | category | String | **参数描述**：实例申请的规格类型。 **取值范围**：枚举类型，取值如下： - CPU：CPU规格。 - GPU：GPU规格。 | | resource_flavor | String | **参数解释**：实例选择的目标资源池节点实例规格。 **取值范围**：不涉及。 | 表8Image | 参数 | 参数类型 | 描述 | |:---|:---|:---| | arch | String | **参数解释**：该镜像所支持处理器架构类型。 **取值范围**：枚举类型，取值如下： - X86_64：x86处理器架构。 - AARCH64：ARM体系架构。 | | create_at | Long | **参数解释**：镜像创建的时间，UTC毫秒。 **取值范围**：不涉及。 | | description | String | **参数解释**：该镜像所对应的描述信息。 **取值范围**：长度限制512个字符。 | | dev_services | Array of strings | **参数解释**：镜像支持的服务。 **取值范围**：枚举类型，取值如下： - NOTEBOOK：镜像支持通过https协议访问Notebook。 - SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。 | | id | String | **参数解释** ：待创建Notebook实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考[查询支持的镜像列表](https://support.huaweicloud.com/api-modelarts/ListImage.html#ZH-CN_TOPIC_0000002753341545)获取。 **取值范围**：不涉及。 | | name | String | **参数解释**：镜像名称。 **取值范围**：长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 | | namespace | String | **参数解释**：镜像所属组织，可以在SWR控制台"组织管理"创建和查看。 **取值范围**：不涉及。 | | origin | String | **参数解释**：指定镜像来源。 **取值范围**：枚举类型，取值如下： - CUSTOMIZE：用户自定义构建镜像。 - IMAGE_SAVE：Notebook实例保存镜像。 | | resource_categories | Array of strings | **参数解释**：镜像支持的规格。枚举类型，取值如下： - CPU - GPU - ASCEND | | service_type | String | **参数解释**：镜像支持服务类型。 **取值范围**：枚举类型，取值如下： - COMMON：通用镜像。 - INFERENCE：建议仅在推理部署场景使用。 - TRAIN：建议仅在训练任务场景使用。 - DEV：建议仅在开发调测场景使用。 - UNKNOWN：未明确设置的镜像支持的服务类型。 | | size | Long | **参数解释**：镜像大小（单位KB）。 **取值范围**：不涉及。 | | status | String | **参数解释**：镜像状态。 **取值范围**：枚举类型，取值如下： - INIT：初始化。 - CREATING：镜像保存中，此时Notebook不可用。 - CREATE_FAILED：镜像保存失败。 - ERROR：错误。 - DELETED：已删除。 - ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建Notebook实例。 | | status_message | String | **参数解释**：镜像保存操作过程中，构建信息展示。 **取值范围**：不涉及。 | | support_res_categories | Array of strings | **参数解释**：镜像支持的规格。 枚举类型，取值如下： - CPU - GPU - ASCEND | | swr_path | String | **参数解释**：SWR镜像地址。 **取值范围**：不涉及。 | | tag | String | **参数解释**：镜像Tag。 **取值范围**：不涉及。 | | type | String | **参数解释**：镜像类型。 **取值范围**：枚举类型，取值如下： - BUILD_IN：系统内置镜像。 - DEDICATED：用户保存的镜像。 | | update_at | Long | **参数解释**：镜像最后更新的时间，UTC毫秒。 **取值范围**：不涉及。 | | visibility | String | **参数解释**：镜像可见度。 **取值范围**：枚举类型，取值如下： - PRIVATE：私有镜像。 - PUBLIC：所有用户可以根据image_id来进行只读使用。 | | workspace_id | String | **参数解释**：工作空间ID。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **取值范围**：不涉及。 | | flavor_type | String | **参数解释**：镜像的资源类型。 **取值范围**：枚举类型，取值如下： - ASCEND_SNT9：昇腾910芯片。 - ASCEND_SNT9B：昇腾910B芯片。 - ASCEND_SNT3：昇腾310芯片。 | | swr_instance_id | String | **参数解释**：企业版SWR仓库ID。 **取值范围**：不涉及。 | | show_tag | String | **参数解释**：镜像展示Tag。 **取值范围**：不涉及。 | | show_name | String | **参数解释**：镜像展示name。 **取值范围**：不涉及。 | | tags | Array of [TmsTagResponse] objects | **参数解释**：镜像标签。 | 表9Lease | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_at | Long | **参数解释**：实例创建的时间，UTC毫秒。 **取值范围**：不涉及。 | | duration | Long | **参数解释**：实例运行时长，以创建时间为起点计算，即"创建时间+duration \> 当前时刻"时，系统会自动停止实例。 **取值范围**：不涉及。 | | enable | Boolean | **参数解释**：是否启用自动停止功能。 **取值范围**：布尔类型： - true：启动自动停止功能。 - false：关闭自动停止功能。 | | type | String | **参数解释**：自动停止类别。 **取值范围**：枚举类型，取值如下： - TIMING：自动停止。 - IDLE：空闲停止。 | | update_at | Long | **参数解释**：实例最后更新（不包括探活心跳）的时间，UTC毫秒。 **取值范围**：不涉及。 | 表10Pool | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：专属资源池ID。 **取值范围**：不涉及。 | | name | String | **参数解释**：专属资源池名称。 **取值范围**：不涉及。 | 表11VolumeRes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | capacity | Integer | **参数解释**：存储容量。 **取值范围**：EVS默认5G，EFS默认50G，最大限制4096G。 | | category | String | **参数解释** ：支持的存储类型。不同存储类型的差异，详见[开发环境中如何选择存储](https://support.huaweicloud.com/devtool-modelarts/devtool-modelarts_0005.html)。 **取值范围**：枚举类型，取值如下： - SFS：弹性文件服务 - EVS：云硬盘 - OBS：对象存储服务 - OBSFS：并行文件系统 - EFS：弹性文件服务（SFS Turbo） | | mount_path | String | **参数解释**：存储挂载至Notebook实例的目录，当前固定在/home/ma-user/work/下。 **取值范围**：不涉及。 | | ownership | String | **参数解释**：资源所属。 **取值范围**：枚举类型，取值如下： - MANAGED：托管，即资源在服务上。 - DEDICATED：非托管，即资源在用户账号上，只有在category为EFS时支持。 | | status | String | **参数解释**：EVS扩容状态，扩容时的状态为RESIZING，此时实例可以正常使用。 **取值范围**：不涉及。 | | id | String | **参数解释**：EFS专属存储盘ID或OBS存储ID，只有作为扩展存储时返回。 **取值范围**：不涉及。 | | read_only | Boolean | **参数解释**：扩展存储挂载目录是否只读。 **取值范围**：不涉及。 | | dew_secret_name | String | **参数解释**：DEW存储的用户AKSK凭据名称。 **取值范围**：不涉及。 | | evs_sku_code | String | **参数解释**：规格包含的evs时，evs存储的sku编码。 **取值范围**：不涉及。 | | uri | String | **参数解释**：只有当category为EFS或OBS或OBSFS时，挂载存储源路径。 **取值范围**：不涉及。 | | mount_type | String | **参数解释**：存储挂载类型。 **取值范围**：枚举类型，取值如下： - STATIC:不支持在实例运行期间挂载以及卸载的存储 - DYNAMIC:支持在实例运行期间挂载以及卸载的存储 | 表12UserResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：用户ID。 **取值范围**：不涉及。 | | name | String | **参数解释**：用户名。 **取值范围**：不涉及。 | | domain | [Domain] object | **参数解释**：domain账号信息。 | 表13Domain | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：账号ID。 **取值范围**：不涉及。 | | name | String | **参数解释**：账号名。 **取值范围**：不涉及。 | 表14AffinityType | 参数 | 参数类型 | 描述 | |:---|:---|:---| | required_during_scheduling_ignored_during_execution | Array of [AffinityRule] objects | 参数描述： 专属池场景下设置强亲和特性 参数约束： key、values、operator必填 | | preferred_during_scheduling_ignored_during_execution | Array of [AffinityRule] objects | 参数描述： 专属池场景下设置弱亲和特性 参数约束： key、values、operator必填，weight选填 | 表15AffinityRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释** ：亲和度描述具体信息。 该标签可以使用系统默认的标签，也可以使用自定义标签。系统默认的节点标签详情请参见[管理节点标签](https://support.huaweicloud.com/usermanual-cce/cce_10_0004.html#cce_10_0004__section74111324152813)。 **取值范围** ：名称段是必需的，必须小于等于 63 个字符，以字母数字字符（\[a-z0-9A-Z\]）开头和结尾， 带有破折号（-），下划线（_），点（ .）和之间的字母数字;前缀是可选的。如果指定，前缀必须是 DNS 子域：由点（.）分隔的一系列 DNS 标签，总共不超过 253 个字符， 后跟斜杠（/）.请参见[标签和选择算符](https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/labels/) | | operator | String | **参数解释**：操作符 **取值范围**：可以设置六种匹配关系（In、NotIn、Exists、DoesNotExist、Gt、Lt）。 In：亲和/反亲和对象的标签在标签值列表（values字段）中。 NotIn：亲和/反亲和对象的标签不在标签值列表（values字段）中。 Exists：亲和/反亲和对象存在指定标签名。 DoesNotExist：亲和/反亲和对象不存在指定标签名。 Gt：调度节点的标签值大于列表值 （字符串比较）。 Lt：调度节点的标签值小于列表值 （字符串比较）。 | | values | Array of strings | 参数解释：设置节点亲和性时，填写节点标签对应的标签值 约束限制：必须为 63 个字符或更少（可以为空），除非标签值为空，必须以字母数字字符（\[a-z0-9A-Z\]）开头和结尾，包含破折号（-）、下划线（_）、点（.）和字母或数字 请参见[标签和选择算符](https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/labels/) | | weight | Integer | 设置弱亲和节点的权重值，该值的取值应为0-100之间，强亲和该值为NULL，弱亲和该值可选 | 表16RunUserInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uid | Integer | 容器启动用户的user id | | gid | Integer | 容器启动用户的group id | | user_name | String | 容器启动用户的user name | | group_name | String | 容器启动用户的group name | 表17VolumeResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | category | String | **参数解释**：notebook返回的扩展存储类型 **参数约束**：不涉及 - OBS：对象存储服务 - OBSFS：并行文件存储 - EFS：弹性文件服务 | | mount_path | String | **参数解释**：存储挂载至Notebook实例的目录 **参数约束**：不涉及 | | url | String | **参数解释**：当category为OBS、OBSFS时，挂载存储源路径。 **参数约束**：不涉及 | | status | String | **参数解释**：存储状态 - MOUNTING: 正在挂载中； - MOUNTED: 已挂载成功； - UNMOUNTING: 正在卸载中； - UNMOUNTED: 已卸载完成； - MOUNT_FAILED: 挂载失败 - UNMOUNT_FAILED：卸载失败； **参数约束**：不涉及 | | mount_type | String | **参数解释**：存储挂载类型，枚举类。 | 表18UserVpcResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_id | String | **参数解释**：虚拟私有网络（VPC）ID。 **取值范围**：不涉及。 | | subnet_id | String | **参数解释**：子网ID。 **取值范围**：不涉及。 | | security_group_ids | Array of strings | **参数解释**：安全组ID列表。 **取值范围**：不涉及。 | | connect_cidrs | String | **参数解释**：连接的CIDR地址列表。 **取值范围**：不涉及。 | | port_id | Array of strings | **参数解释**：网卡ID。 **取值范围**：不涉及。 | | port_ip | String | **参数解释**：网卡ip。 **取值范围**：不涉及。 | | nat_id | String | **参数解释**：NAT ID。 **取值范围**：不涉及。 | | eip_id | String | **参数解释**：EIP ID。 **取值范围**：不涉及。 | 表19TmsTagResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：TMS标签的key。 **取值范围**：不涉及。 | | value | String | **参数解释**：TMS标签的value。 **取值范围**：不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v1/{project_id}/notebooks ``` #### 响应示例 **状态码：200** ``` { "current" : 0, "data" : [ { "description" : "api-test", "feature" : "DEFAULT", "flavor" : "modelarts.vm.cpu.free", "id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48", "image" : { "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090", "name" : "notebook2.0-mul-kernel-cpu-cp36", "swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841805439, "duration" : 3600000, "enable" : true, "update_at" : 1638841805439 }, "name" : "notebook_5ee4bf0e", "status" : "CREATING", "token" : "58ba50c6-e8ff-245c-4840-49e51aa70737", "volume" : { "category" : "EVS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50 }, "workspace_id" : "0" }, { "description" : "api-test", "feature" : "NOTEBOOK", "flavor" : "modelarts.vm.cpu.2u", "id" : "f9937afa-4451-42db-a76b-72d624749f66", "image" : { "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090", "name" : "notebook2.0-mul-kernel-cpu-cp36", "swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841744515, "duration" : 3600000, "enable" : true, "update_at" : 1638841744515 }, "name" : "notebooks_test", "status" : "CREATING", "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022", "volume" : { "category" : "EVS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50 }, "workspace_id" : "0" } ], "pages" : 1, "size" : 10, "total" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 401 | Unauthorized。 | | 403 | Forbidden。 | | 404 | Not Found。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。