更新时间:2025-11-19 GMT+08:00

API概览

Notebook实例管理

表1 Notebook实例管理

API

说明

查询Notebook实例列表

查询Notebook实例列表接口用于获取满足特定条件的Notebook实例信息。该接口适用于以下场景:用户管理多个Notebook实例或查看特定状态的Notebook实例时,可通过此接口获取相关信息。使用该接口的前提条件是用户已创建Notebook实例,并且具有相应的查询权限。调用成功后,系统将返回符合条件的Notebook实例列表,包含实例ID、状态、创建时间等详细信息。若用户无权限访问或查询条件不明确,接口将返回相应的错误信息或空列表。

创建Notebook实例

创建Notebook实例接口用于根据指定的参数创建一个新的Notebook实例。该接口适用于以下场景:用户需要为特定任务或项目创建Notebook实例时,可通过此接口指定实例规格、AI引擎镜像和存储配置。使用该接口的前提条件是用户已登录系统并具有创建Notebook实例的权限,同时需提供有效的创建参数。调用该接口后,系统将异步创建Notebook实例,用户可通过查询接口获取实例状态。创建完成后,用户可通过网页或SSH客户端访问Notebook实例。若用户无权限创建实例或参数无效,接口将返回相应的错误信息。异常情况包括:若系统资源不足,或创建操作失败,接口将返回相应的错误提示。

查询所有Notebook实例列表

查询所有Notebook实例列表接口用于获取所有已创建的Notebook实例信息。该接口适用于以下场景:用户需要全面了解当前系统中所有Notebook实例的状态、资源使用情况或管理多个Notebook实例时,可通过此接口获取相关信息。使用该接口的前提条件是用户已创建Notebook实例,并且具有相应的查询权限。调用成功后,系统将返回所有Notebook实例的列表,包含实例ID、状态、创建时间等详细信息。若用户无权限访问,接口将返回相应的错误信息。

查询Notebook实例详情

查询Notebook实例详情接口用于获取指定Notebook实例的详细信息。该接口适用于以下场景:用户需要查看特定Notebook实例的详细配置、运行状态或获取访问链接时,可通过此接口获取相关信息。使用该接口的前提条件是Notebook实例已存在且用户具有相应的查询权限。调用成功后,系统将返回实例ID、名称、规格、镜像、实例状态和实例可打开的URL等详细信息。若实例不存在或用户无权限访问,接口将返回相应的错误信息。

更新Notebook实例

更新Notebook实例接口用于修改Notebook实例的配置信息,包括名称、描述、规格和镜像等。该接口适用于以下场景:用户需要调整Notebook实例的配置以适应新的需求时,可通过此接口更新实例的详细信息。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限,同时Notebook实例必须处于停止状态。调用该接口后,系统将更新指定Notebook实例的配置信息。若用户无权限操作指定实例或Notebook实例未停止,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或更新参数无效,接口将返回相应的错误提示。

删除Notebook实例

删除Notebook实例接口用于移除已创建的Notebook实例及其相关资源。该接口适用于以下场景:用户需要清理不再使用的Notebook实例时,可通过此接口删除指定的Notebook实例,包括其容器和所有存储资源。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限。调用该接口后,系统将删除指定的Notebook实例及其相关资源。若用户无权限操作指定实例或Notebook实例未停止,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或删除操作失败,接口将返回相应的错误提示。

通过运行的实例保存成容器镜像

通过运行的实例保存成容器镜像接口用于将正在运行的实例保存为容器镜像。该接口适用于以下场景:用户需要保存当前运行环境以便后续使用或开发时,可通过此接口将实例保存为镜像。使用该接口的前提条件是用户已登录系统并具有访问目标实例的权限,同时实例必须处于运行状态。调用该接口后,系统将保存实例的当前状态为容器镜像,包括安装的依赖包和插件。若用户无权限访问指定实例或实例未运行,接口将返回相应的错误信息。

查询Notebook支持的有效规格列表

查询Notebook支持的有效规格列表接口用于获取运行Notebook实例时可使用的规格选项。该接口适用于以下场景:用户需要了解Notebook实例支持的配置选项时,可通过此接口查询可用的规格列表。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例的权限。调用该接口后,系统将返回Notebook实例支持的有效规格列表,包括内存、CPU等配置信息。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。

查询Notebook支持的可切换规格列表

查询Notebook支持的可切换规格列表接口用于获取创建Notebook实例时可选择的规格选项。该接口适用于以下场景:用户需要了解Notebook实例支持的配置选项时,可通过此接口查询可用的规格列表。使用该接口的前提条件是用户已登录系统并具有创建Notebook实例的权限。调用该接口后,系统将返回Notebook实例支持的可切换规格列表,包括内存、CPU等配置信息。若用户无权限创建Notebook实例,接口将返回相应的错误信息。

查询运行中的Notebook可用时长

查询运行中的Notebook可用时长接口用于获取正在运行的Notebook实例的剩余可用时间。该接口适用于以下场景:用户需要了解Notebook实例的剩余运行时间以合理安排任务时,可通过此接口查询指定实例的可用时长。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将返回指定Notebook实例的可用时长信息。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或查询操作失败,接口将返回相应的错误提示。

Notebook时长续约

Notebook时长续约接口用于延长运行中的Notebook实例的运行时间。该接口适用于以下场景:用户需要延长Notebook实例的使用时间以完成长时间任务时,可通过此接口延长指定实例的运行时间。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将延长指定Notebook实例的运行时间,用户可继续使用。若用户无权限操作指定实例或Notebook实例未运行,接口将返回相应的错误信息。

启动Notebook实例

启动Notebook实例接口用于启动已创建的Notebook实例。该接口适用于以下场景:用户需要开始运行Notebook实例以进行数据处理、模型训练或开发时,可通过此接口启动指定的Notebook实例。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限,同时Notebook实例必须处于停止状态且配置正确。调用该接口后,系统将启动指定的Notebook实例,用户可开始使用。若用户无权限操作指定实例或Notebook实例未停止,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或启动操作失败,接口将返回相应的错误提示。

停止Notebook实例

停止Notebook实例接口用于停止正在运行的Notebook实例。该接口适用于以下场景:用户需要释放Notebook实例占用的资源或结束当前运行的任务时,可通过此接口停止指定的Notebook实例。使用该接口的前提条件是用户已登录系统并具有操作目标Notebook实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将停止指定的Notebook实例,释放相关资源。若用户无权限操作指定实例或Notebook实例未运行,接口将返回相应的错误信息。异常情况包括:若指定的Notebook实例不存在,或停止操作失败,接口将返回相应的错误提示。

查询用户所有Notebook资源池实例详情

查询用户所有Notebook资源池实例详情接口用于获取用户关联的所有Notebook资源池实例的详细信息。该接口适用于以下场景:当用户创建Notebook示例需要选择资源池时,可通过此接口获取所有资源池实例列表信息。使用该接口的前提条件是用户已注册并登录系统,且具有查看资源池实例的权限。调用成功后,接口将返回包含所有资源池实例的详细信息列表,包括实例名称、状态、节点规格等。若用户未登录、无权限访问或系统内部出现错误,接口将返回相应的错误信息,如未认证、无权限或服务不可用等。

查询Notebook资源池详情

查询Notebook资源池详情接口用于获取资源池的详细信息。该接口适用于以下场景:当用户需要创建Notebook实例作业时,可通过此接口查询指定集群的详细信息。使用该接口的前提条件是集群已成功纳管且用户具有相应的访问权限。调用该接口后,系统将返回集群的实例ID、名称、Flavor规格、实例状态以及实例可打开的URL等详细信息。若集群不存在、未被纳管或用户无权限访问,接口将返回相应的错误信息。

查询当前用户指定特性的开关及配额

查询当前用户指定特性的开关及配额接口用于获取指定特性在当前用户下的开关状态及配额信息。该接口适用于以下场景:当用户需要了解特定特性是否已开启、查看配额限制或监控已使用的资源情况时,可通过此接口查询相关信息。使用该接口的前提条件是用户已登录且具有查询权限,同时指定的特性必须存在。调用该接口后,系统将返回该特性是否已开启、配额总量及已使用的资源情况等详细信息。若用户无权限查询、特性不存在或系统出现异常,接口将返回相应的错误信息。

动态挂载OBS

表2 动态挂载OBS

API

说明

获取动态挂载OBS实例信息列表

获取动态挂载OBS实例信息列表接口用于获取可供挂载到运行中Notebook实例中的OBS并行文件系统实例信息。该接口适用于以下场景:用户需要将OBS实例挂载到Notebook实例的指定文件目录时,可通过此接口获取可用的OBS实例列表。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例和OBS实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将返回可供动态挂载的OBS实例信息列表。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。

动态挂载OBS

动态挂载OBS接口用于将OBS并行文件系统挂载到运行中的Notebook实例的指定文件目录。该接口适用于以下场景:用户需要在Notebook实例中直接操作OBS存储中的文件时,可通过此接口将OBS实例挂载到指定目录,实现文件系统的读写操作。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例和OBS实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将在Notebook实例中挂载指定的OBS实例,用户可在容器中以文件系统方式读写OBS中的对象。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。

获取动态挂载OBS实例详情

获取动态挂载OBS实例详情接口用于获取已挂载到运行中Notebook实例中的OBS并行文件系统实例的详细信息。该接口适用于以下场景:用户需要查看Notebook实例中已挂载的OBS实例的详细信息时,可通过此接口获取挂载的OBS实例信息。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例和OBS实例的权限,同时Notebook实例必须处于运行状态。调用该接口后,系统将返回指定Notebook实例中挂载的OBS实例的详细信息。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。

动态卸载OBS

动态卸载OBS接口用于从运行中的Notebook实例中卸载已挂载的OBS并行文件系统实例。该接口适用于以下场景:用户需要清理或重新组织Notebook实例的挂载资源时,可通过此接口卸载指定的OBS实例。使用该接口的前提条件是用户已登录系统并具有访问目标Notebook实例和OBS实例的权限,同时Notebook实例必须处于运行状态且已挂载OBS实例。调用该接口后,系统将卸载指定的OBS实例,Notebook容器将无法再操作OBS中的对象,但OBS存储中的对象保持不变。若用户无权限访问指定实例或Notebook实例未运行,接口将返回相应的错误信息。

镜像管理

表3 镜像管理

API

说明

查询支持的镜像列表

查询支持的镜像列表接口用于根据指定条件分页查询满足条件的所有镜像。该接口适用于以下场景:当用户需要查找特定镜像、管理镜像仓库或选择合适的镜像版本进行部署时,可通过此接口获取符合条件的镜像列表。使用该接口的前提条件是镜像仓库已存在且用户具有访问权限。查询操作完成后,将返回满足条件的镜像列表,包括镜像ID、名称、版本、类型、状态、大小和创建时间等详细信息。若镜像仓库不存在、用户无权限访问或查询条件有误,接口将返回相应的错误信息。

注册自定义镜像

注册自定义镜像接口用于将用户自定义的镜像注册到ModelArts镜像管理。该接口适用于以下场景:当用户需要将自己的自定义镜像(如特定算法环境、工具链或配置)集成到ModelArts平台时,可通过此接口将镜像注册到镜像管理中以便后续使用。使用该接口的前提条件是用户具备ModelArts镜像管理权限,并且需要提供有效的镜像地址和符合要求的镜像格式。注册操作完成后,自定义镜像将被成功添加到ModelArts镜像列表中,用户可以在后续任务中选择使用该镜像。若镜像地址无效、镜像格式不符合要求或用户无权限操作,接口将返回相应的错误信息。

查询用户镜像列表

查询用户镜像列表接口用于查询用户镜像信息概览,以镜像名称作为聚合的信息。该接口适用于以下场景:当用户需要管理多个镜像或了解各镜像的基本信息时,可通过此接口获取镜像列表及其概览信息。使用该接口的前提条件是用户具备镜像管理权限,并且镜像已存在。查询操作完成后,将返回用户所有镜像的列表,包括镜像名称、版本、状态等信息。若镜像不存在或用户无权限访问,接口将返回相应的错误信息。

查询镜像详情

查询镜像详情接口用于查询镜像的详细信息。该接口适用于以下场景:当用户需要了解特定镜像的详细信息(如镜像名称、版本、创建时间、大小、状态等)或对镜像执行一些操作时,可通过此接口获取镜像的详细信息。使用该接口的前提条件是用户具备镜像管理权限,并且待查询镜像有效且存在。查询操作完成后,将返回镜像的详细信息,包括镜像ID、名称、版本、创建时间、大小以及状态等。若镜像不存在或用户无权限访问,接口将返回相应的错误信息。

删除镜像

删除镜像接口用于删除镜像对象,对于个人私有镜像可以通过参数一并删除SWR镜像内容。该接口适用于以下场景:当镜像不再需要、配置错误或需要清理资源时,用户可通过此接口删除指定的镜像对象。使用该接口的前提条件是镜像已存在且用户具有删除权限。删除操作完成后,镜像对象将被永久移除,相关资源和配置也将被清理。若镜像不存在、用户无权限操作或镜像正在被使用,接口将返回相应的错误信息。

同步镜像状态

同步镜像状态接口用于修正镜像状态的异常情况。该接口适用于以下场景:当镜像状态因误操作、网络问题或系统故障等原因出现异常时,用户可通过此接口同步镜像的最新状态。使用该接口的前提条件是镜像已存在且用户具有相应的操作权限。同步操作完成后,镜像的状态将被更新为最新的正确状态,相关资源和配置也将被同步。若镜像不存在、用户无权限操作或同步过程中出现错误,接口将返回相应的错误信息。

算法管理

表4 算法管理

API

说明

创建算法

创建算法接口用于在ModelArts平台上创建一个新的算法。

查询算法列表

查询算法列表接口用于获取ModelArts平台上所有算法的列表。

查询算法详情

查询算法详情接口用于获取ModelArts平台上指定算法的详细信息。

更新算法

更新算法接口用于修改已存在的算法信息。

删除算法

删除算法接口用于从ModelArts平台上移除已注册的算法。

训练作业管理

表5 训练作业管理

API

说明

创建训练作业

创建训练作业接口用于在ModelArts平台上启动新的训练任务。

查询训练作业详情

查询训练作业详情接口用于获取ModelArts平台上指定训练作业的详细信息。

更新训练作业描述

更新训练作业描述接口用于修改已存在的训练作业的描述信息。

删除训练作业

删除训练作业接口用于从ModelArts平台上移除已创建的训练作业。

终止训练作业

终止训练作业接口用于停止ModelArts平台上正在运行的训练作业,只可终止创建中、等待中、运行中的作业。

查询训练作业指定任务的日志(预览)

查询训练作业指定任务的日志(预览)接口用于获取ModelArts平台上指定训练作业任务的日志信息。

查询训练作业指定任务的日志(OBS链接)

查询训练作业指定任务的日志(OBS链接)接口用于获取指定训练作业任务的日志文件在OBS(对象存储服务)中的访问链接。

查询训练作业指定任务的运行指标

查询训练作业指定任务的运行指标接口用于获取ModelArts平台上指定训练作业任务的运行指标。

查询训练作业列表

查询训练作业列表接口用于获取ModelArts平台上所有训练作业的列表。

获取训练作业事件列表

获取训练作业事件列表接口用于获取ModelArts平台上指定训练作业的事件列表。

资源和引擎规格

表6 资源和引擎规格

API

说明

获取训练作业支持的公共规格

获取训练作业支持的公共规格接口用于获取ModelArts平台上支持的训练作业资源规格列表。

获取训练作业支持的AI预置框架

获取训练作业支持的AI预置框架接口用于查询当前系统中支持的AI预置框架列表。

模型管理

表7 模型管理

API

说明

查询模型runtime

查询模型AI引擎以及runtime。

查询AI应用列表

查询AI应用列表,可以根据不同的检索参数进行查询。

创建AI应用

导入元模型创建AI应用。

查询AI应用详情

查询AI应用详情,根据AI应用ID查询AI应用的详细信息。

删除AI应用

删除AI应用,根据AI应用ID删除指定AI应用,cascade取值为true时除了删除AI应用ID指定的AI应用,还会删除其他与指定AI应用同名不同版本的AI应用;默认只删除当前AI应用ID所对应的AI应用。

APP认证管理

表8 APP认证管理

API

说明

获取APP列表

获取APIG APP基本信息列表,用户只能获取自己创建的APP信息。

创建APP

创建API网关应用(简称APP),每个用户最多只能创建5个APP,有需求可以申请增加配额。

查询APP详情

查询指定的APP详情。

删除APP

删除指定的APP,只有APP的创建用户才可以删除APP,且APP没有绑定的API。

增加AppCode

为指定API网关应用创建新的AppCode,只有APP的创建用户才可以创建AppCode,且只有共享/专享版APIG的APP才能创建AppCode。

重置AppCode

重置指定API网关应用的指定的AppCode,只有APP的创建用户才可以重置AppCode,且只有共享/专享版APIG的APP才支持AppCode。

删除AppCode

删除指定API网关应用的指定的AppCode,只有APP的创建用户才可以删除AppCode,且只有共享/专享版APIG的APP才支持AppCode。

重置AppSecret

重置指定API网关应用的AppSecret,只有APP的创建用户才可以重置AppSecret。

获取用户绑定APP的api列表

获取用户绑定app的API列表。

注册API并授权给APP

注册API并将API授权给APP,只有对服务有更新权限的华为云用户可以调用。

删除API

删除指定的API,只有对API所属服务有删除权限的用户才可以删除API。

授权API至APP

将指定的API授权给APP。API的认证方式必须为APP认证,APP的创建用户必须是API所属服务的创建者,且请求用户对API所属服务必须有更新权限。

更新API授权

更新API的授权关系。API的认证方式必须为APP认证,APP的创建用户必须是API所属服务的创建者,且请求用户对API所属服务必须有更新权限。

解除API对APP的授权

解除指定的API对APP的授权,请求用户对API所属服务必须有更新权限。同URL:/v1/{project_id}/app-auth/{service_id}/apis/{api_id}/auths

获取API授权关系列表

获取指定的API与APP授权关系列表,API的认证方式必须是APP认证,管理员可以获取所有API的授权信息,普通用户只能获取自己有访问权限的服务下的API的授权信息。

创建API

创建API,未将API授权给APP。

查询API

查询指定API详情。

查询API和APP

查询服务授权的API、APP信息。

查询APP的API认证信息

查询APP的API认证信息。

查询APP是否存在

查询APP是否存在。

服务管理

表9 服务管理

API

说明

查询服务监控信息

查询服务监控信息。

查询服务列表

查询模型服务列表。

部署服务

将模型部署为服务。

查询支持的服务部署规格

查询支持的服务部署规格列表。

查询服务详情

查询模型服务详情,根据服务ID查询服务详情。

更新服务配置

更新模型服务配置。也可以使用此接口启停服务。

通过patch操作对服务进行更新

通过patch操作对服务进行更新。patch的格式可以参照json patch。

删除服务

删除模型服务,仅可删除本人名下的服务。

更新模型服务的单个属性

更新模型服务的单个属性,目前只支持instance_count(更新模型服务实例数量),仅运行中、告警、异常状态下的在线服务可以执行该操作。

查询服务事件日志

查询服务事件日志,包含服务的操作记录及部署过程中的关键动作、部署失败原因。

查询服务更新日志

查询实时服务更新日志。

添加资源标签

给指定服务添加标签(目前只支持在线服务),当添加的标签key已存在,则覆盖该标签的value。

删除资源标签

删除服务(目前只支持在线服务)的标签,支持批量删除。

查询推理服务标签

查询当前项目下的推理服务标签,默认查询所有工作空间,无权限不返回标签数据。

查询推理VPC访问通道信息的API

该接口用于查询推理VPC访问通道。

配置管理

表10 配置管理

API

说明

查询OS的配置参数

查询OS的配置参数接口用于获取ModelArts OS服务的配置参数,如网络网段、用户资源配额等。该接口适用于以下场景:当需要了解当前ModelArts OS服务的网络配置、资源分配情况或进行系统管理时,用户可通过此接口查询相关的配置参数。使用该接口的前提条件是用户具有访问ModelArts OS服务的权限,且服务处于正常运行状态。查询操作完成后,用户将获得指定的配置参数信息,便于进行后续的资源规划或系统优化。若用户无权限访问、服务不可用或请求参数无效,接口将返回相应的错误信息。

插件模板管理

表11 插件模板管理

API

说明

查询插件模板

查询插件模板接口用于获取指定插件模板的详细信息。该接口适用于以下场景:当需要了解特定插件模板的配置、功能或使用方式时,用户可通过此接口查询插件模板的详细信息。使用该接口的前提条件是插件模板已存在且用户具有访问权限。查询操作完成后,用户将获得指定插件模板的详细信息,包括模板的配置参数、功能描述等,便于后续的插件开发或配置管理。若插件模板不存在或用户无权限访问,接口将返回相应的错误信息。

查询插件模板列表

查询插件模板列表接口用于获取插件模板的基本信息列表。该接口适用于以下场景:当需要浏览或管理插件模板时,用户可通过此接口查询所有可用的插件模板信息,以便选择或进一步操作。使用该接口的前提条件是用户具有访问插件模板的权限,且插件模板服务处于正常运行状态。查询操作完成后,用户将获得插件模板的列表信息,包括模板名称、类型、版本等,便于后续的插件开发或管理。若用户无权限访问、插件模板服务不可用或请求参数无效,接口将返回相应的错误信息。

节点管理

表12 节点管理

API

说明

查询资源池节点列表

查询资源池节点列表接口用于获取指定资源池中的节点信息列表。该接口适用于以下场景:当需要了解资源池中节点的分布、状态或资源使用情况时,用户可通过此接口查询资源池中的节点列表,以便进行资源监控、分配或管理。使用该接口的前提条件是资源池已创建且处于可用状态,且用户具有访问资源池的权限。查询操作完成后,用户将获得资源池中节点的详细信息,包括节点ID、状态、资源使用情况等,便于后续的资源管理和优化。若资源池不存在、用户无权限访问或请求参数无效,接口将返回相应的错误信息。

批量删除节点

批量删除节点接口用于批量删除指定资源池中的节点。该接口适用于以下场景:当需要清理资源池中的冗余节点、重新分配资源或移除故障节点时,用户可通过此接口批量删除指定的节点。使用该接口的前提条件是资源池已创建且处于可用状态,用户具有删除节点的权限,且资源池中至少保留一个节点。删除操作完成后,指定的节点将被永久移除,资源池中剩余的节点将继续提供服务。若资源池不存在、节点不存在、用户无权限操作或资源池中节点不足,接口将返回相应的错误信息。

批量对节点功能上锁

批量对节点功能上锁接口用于批量对指定节点的功能进行上锁操作,被上锁的功能在控制台将无法正常使用。该接口适用于以下场景:当需要临时禁用某些节点的功能以防止误操作、进行系统维护或测试时,用户可通过此接口批量对节点功能进行上锁。使用该接口的前提条件是节点功能已存在且用户具有管理员权限。上锁操作完成后,指定节点的功能将在控制台被禁用,无法进行相关操作。若节点功能不存在、用户无权限操作或请求参数无效,接口将返回相应的错误信息。

批量对节点功能解锁

批量对节点功能解锁接口用于批量解除指定节点功能的锁定状态,使被上锁的功能在控制台恢复正常可用状态。该接口适用于以下场景:当需要恢复被锁定的节点功能以正常使用、完成系统维护或测试后,用户可通过此接口批量对节点功能进行解锁。使用该接口的前提条件是节点功能已被上锁且用户具有管理员权限。解锁操作完成后,指定节点的功能将在控制台恢复正常,用户可以正常使用相关功能。若节点功能未被锁定、用户无权限操作或请求参数无效,接口将返回相应的错误信息。

重置节点

重置节点接口用于将指定节点恢复到初始状态,清除节点上的数据和配置。该接口适用于以下场景:当节点出现故障、配置错误、需要重新部署或进行系统恢复时,用户可通过此接口重置节点,使其恢复到出厂或初始状态。使用该接口的前提条件是节点已存在且用户具有管理员权限。重置操作完成后,节点上的所有数据和配置将被清除,节点将被重新启动并恢复到初始状态。若节点不存在、用户无权限操作或节点处于不可重置状态(如正在运行任务),接口将返回相应的错误信息。

节点规格变更

节点规格变更接口用于调整指定节点的规格(如步长),例如将节点从8节点超节点扩容到16节点超节点。该接口适用于以下场景:当需要根据业务需求调整节点的资源容量、优化资源利用率或进行系统升级时,用户可通过此接口变更节点的规格。使用该接口的前提条件是节点已创建且处于可变更状态,目标规格在支持范围内,且用户具有管理员权限。规格变更完成后,节点的资源容量将按新规格调整,相关服务和配置将重新加载以适应新的规格。若节点不存在、节点状态不允许变更、目标规格不支持或用户无权限操作,接口将返回相应的错误信息。

批量迁移节点

批量迁移节点接口用于在资源池的多集群之间批量迁移节点,将节点从一个集群迁移到另一个集群。该接口适用于以下场景:当资源池的节点分布不均衡、需要进行集群维护或业务扩展时,用户可通过此接口将指定节点从一个集群迁移到另一个集群。使用该接口的前提条件是资源池中至少包含两个节点,且目标集群具备足够的资源容量以接收迁移节点。迁移操作完成后,节点将从原集群转移到目标集群,资源池的节点总数保持不变,但节点分布将发生变化。若资源池只有一个节点、目标集群资源不足或用户无权限操作,接口将返回相应的错误信息。

批量为节点绑定逻辑子池

批量为节点绑定逻辑子池接口用于在物理专属池开启节点绑定功能时,对逻辑子池中的节点进行逻辑子池的换绑操作。该接口适用于以下场景:当需要重新分配资源、调整业务负载或优化资源使用效率时,用户可通过此接口将指定节点从当前逻辑子池迁移到另一个逻辑子池。使用该接口的前提条件是物理专属池已开启节点绑定功能,且目标逻辑子池已存在并具备足够的资源容量。绑定操作完成后,节点将从原逻辑子池解绑并绑定到目标逻辑子池,原逻辑子池的节点数减少,目标逻辑子池的节点数增加。若节点未绑定到任何逻辑子池、目标逻辑子池不存在或资源不足,或用户无权限操作,接口将返回相应的错误信息。

事件管理

表13 事件管理

API

说明

查询事件列表

查询事件列表接口用于获取系统中记录的事件信息。该接口适用于以下场景:当用户需要监控系统状态、排查问题或进行审计时,可通过此接口查询系统中发生的事件记录。使用该接口的前提条件是用户具有相应的权限,并且系统中已存在事件记录。查询操作完成后,接口将返回事件列表,包含事件ID、类型、时间、描述等信息。若用户无权限、事件记录不存在或查询参数有误,接口将返回相应的错误信息。

网络管理

表14 网络管理

API

说明

创建网络资源

创建网络资源接口用于在系统中创建新的网络资源。该接口适用于以下场景:当需要为业务扩展、资源规划或网络架构调整时,用户可通过此接口创建新的网络资源,如虚拟网络、子网或路由等。使用该接口的前提条件是用户具有管理员权限,并且系统中具备足够的资源支持新网络资源的创建。创建操作完成后,新的网络资源将被成功添加到系统中,并可用于后续的业务配置。若用户无权限、资源不足或输入参数有误,接口将返回相应的错误信息。

查询网络资源列表

查询网络资源列表接口用于获取系统中已创建的网络资源信息。该接口适用于以下场景:当用户需要监控网络状态、进行资源规划、排查网络问题或进行审计时,可通过此接口查询系统中现有的网络资源列表。使用该接口的前提条件是用户具有相应的权限,并且系统中已存在网络资源。查询操作完成后,接口将返回网络资源列表,包含资源ID、类型、状态、创建时间等详细信息。若用户无权限、系统中无网络资源或查询参数有误,接口将返回相应的错误信息。

查询网络资源

查询网络资源接口用于获取指定网络资源的详情信息。该接口适用于以下场景:当用户需要查看特定网络资源的详细配置、状态或属性时,可通过此接口查询指定网络资源的详细信息。使用该接口的前提条件是用户具有相应的权限,并且指定的网络资源已存在于系统中。查询操作完成后,接口将返回指定网络资源的详细信息,包括资源ID、类型、状态、配置参数等。若指定的网络资源不存在、用户无权限操作或输入参数有误,接口将返回相应的错误信息。

删除网络资源

删除网络资源接口用于移除指定的网络资源。该接口适用于以下场景:当网络资源不再需要、配置错误或需要清理资源时,用户可通过此接口删除指定的网络资源。使用该接口的前提条件是网络资源已存在且用户具有管理员权限。删除操作完成后,指定的网络资源将被永久移除,相关配置和关联关系也将被清理。若指定的网络资源不存在、用户无权限操作或资源被其他资源依赖,接口将返回相应的错误信息。

更新网络资源

更新网络资源接口用于修改指定网络资源的配置信息。该接口适用于以下场景:当需要调整网络资源的属性、修复配置错误或优化资源设置时,用户可通过此接口更新指定网络资源的详细信息。使用该接口的前提条件是网络资源已存在且用户具有管理员权限。更新操作完成后,指定网络资源的配置信息将被成功修改,系统将反映最新的资源状态和属性。若指定的网络资源不存在、用户无权限操作或输入参数有误,接口将返回相应的错误信息。

资源指标

表15 资源指标

API

说明

查询资源实时利用率

查询资源实时利用率接口用于获取当前项目下所有资源池的实时利用率信息。该接口适用于以下场景:当用户需要监控资源使用情况、进行资源优化、容量规划或故障排查时,可通过此接口查询资源池的实时利用率,包括CPU、内存、存储等资源的使用情况。使用该接口的前提条件是用户具有访问该项目的权限,并且资源池已存在且处于运行状态。查询操作完成后,接口将返回资源池的实时利用率数据,包含利用率百分比、资源类型、时间戳等详细信息。若用户无权限、资源池不存在或系统无法获取实时数据,接口将返回相应的错误信息。

资源池管理

表16 资源池管理

API

说明

查询资源池节点自定义配置

查询资源池节点自定义配置接口用于获取指定资源池节点的自定义配置信息。该接口适用于以下场景:当需要查看资源池节点的详细配置、优化资源分配或管理节点资源时,用户可通过此接口获取节点的自定义配置数据。使用该接口的前提条件是资源池节点已存在且用户具有访问该节点的权限。调用接口成功后,系统将返回资源池节点的自定义配置信息,包括硬件规格、软件环境、网络设置等详细参数。若资源池节点不存在、用户无权限访问或节点配置信息未正确配置,接口将返回相应的错误信息。

创建资源池

创建资源池接口用于在系统中创建新的资源池。该接口适用于以下场景:当需要为新业务分配资源、优化资源管理或进行资源隔离时,用户可通过此接口创建新的资源池,用于管理计算、存储、网络等资源。使用该接口的前提条件是用户具有管理员权限,并且系统中具备足够的资源支持新资源池的创建。创建操作完成后,新的资源池将被成功添加到系统中,并处于可用状态,可支持后续的资源分配和管理。若用户无权限、系统资源不足或输入参数有误,接口将返回相应的错误信息。

查询资源池列表

查询资源池列表接口用于获取系统中已创建的资源池信息。该接口适用于以下场景:当用户需要监控资源池状态、进行资源规划、管理资源分配或进行审计时,可通过此接口查询系统中现有的资源池列表。使用该接口的前提条件是用户具有相应的权限,并且系统中已存在资源池。查询操作完成后,接口将返回资源池列表,包含资源池ID、名称、类型、状态、资源配额等详细信息。若用户无权限、系统中无资源池或查询参数有误,接口将返回相应的错误信息。

查询资源池

查询资源池信息接口用于获取指定资源池的详细信息。该接口适用于以下场景:当用户需要查看特定资源池的详细配置、状态、资源使用情况或进行资源管理时,可通过此接口查询指定资源池的详细信息。使用该接口的前提条件是用户具有相应的权限,并且指定的资源池已存在于系统中。查询操作完成后,接口将返回资源池的详细信息,包括资源池ID、名称、类型、状态、资源配额、利用率等。若指定的资源池不存在、用户无权限操作或输入参数有误,接口将返回相应的错误信息。

删除资源池

删除资源池接口用于移除指定的资源池。该接口适用于以下场景:当资源池不再需要、配置错误或需要清理资源时,用户可通过此接口删除指定的资源池。使用该接口的前提条件是资源池已存在且用户具有管理员权限。删除操作完成后,指定的资源池将被永久移除,相关资源和配置也将被清理。若资源池不存在、用户无权限操作或资源池被其他资源依赖,接口将返回相应的错误信息。

更新资源池

更新资源池接口用于修改指定资源池的配置和容量。该接口适用于以下场景:当资源池需要扩展容量、调整配置或优化性能时,用户可通过此接口更新资源池的相关信息。使用该接口的前提条件是资源池已存在且用户具有管理员权限。更新操作完成后,资源池的配置和容量将被更新,相关资源和配置也将被调整。若资源池不存在、用户无权限操作或资源池处于不可更新状态,接口将返回相应的错误信息。

资源池监控

资源池监控接口用于获取指定资源池的实时或历史监控信息。该接口适用于以下场景:当需要实时查看资源池的资源使用情况、性能状态或历史数据时,用户可通过此接口获取资源池的监控数据。使用该接口的前提条件是资源池已存在且用户具有管理员权限。调用接口成功后,系统将返回资源池的监控信息,包括资源使用率、性能指标及历史趋势等数据。若资源池不存在、用户无权限操作或资源池当前不可用,接口将返回相应的错误信息。

资源池统计

资源池统计接口用于获取指定资源池的统计信息。该接口适用于以下场景:当需要了解资源池的资源使用情况、分配情况或利用率时,用户可通过此接口获取资源池的统计数据。使用该接口的前提条件是资源池已存在且用户具有管理员权限。调用接口成功后,系统将返回资源池的统计信息,包括资源使用总量、已分配量、利用率及资源分配趋势等数据。若资源池不存在、用户无权限操作或资源池当前不可用,接口将返回相应的错误信息。

资源规格管理

表17 资源规格管理

API

说明

查询资源规格列表

查询资源规格列表接口用于获取可用的资源规格信息。该接口适用于以下场景:当需要查看或选择资源规格以创建资源池、分配资源或了解可用资源规格时,用户可通过此接口获取资源规格的详细信息。使用该接口的前提条件是用户具有相应的权限(如管理员权限或资源管理权限)。调用接口成功后,系统将返回资源规格的列表,包括规格ID、名称、CPU核数、内存大小、存储容量等详细信息。若用户无权限访问该接口或系统中未配置资源规格,接口将返回相应的错误信息。

资源池作业管理

表18 资源池作业管理

API

说明

查询资源池作业列表

查询专属资源池作业列表接口用于获取指定专属资源池中的作业信息列表。该接口适用于以下场景:当需要监控专属资源池的资源使用情况、查看作业状态或管理资源分配时,用户可通过此接口获取专属资源池中作业的详细信息。使用该接口的前提条件是专属资源池已存在且用户具有相应的权限(如管理员权限或资源管理权限)。调用接口成功后,系统将返回专属资源池中作业的列表,包括作业ID、名称、状态、资源使用情况等详细信息。若专属资源池不存在、用户无权限操作或资源池当前不可用,接口将返回相应的错误信息。

查询专属资源池作业统计信息

查询专属资源池作业统计信息接口用于获取指定专属资源池中作业的统计信息。该接口适用于以下场景:当需要了解专属资源池中作业的整体运行情况、资源使用效率或作业状态分布时,用户可通过此接口获取统计信息。使用该接口的前提条件是专属资源池已存在且用户具有相应的权限(如管理员权限或资源管理权限)。调用接口成功后,系统将返回专属资源池中作业的统计信息,包括作业总数、运行中作业数、完成作业数、资源使用率等数据。若专属资源池不存在、用户无权限操作或资源池当前不可用,接口将返回相应的错误信息。

DevServer管理

表19 DevServer管理

API

说明

查询用户所有DevServer实例列表

查询用户所有DevServer实例列表。

创建DevServer

创建LiteServer 弹性云服务器、裸金属服务器及超节点服务器。

查询DevServer实例详情

查询DevServer实例详情。

删除DevServer实例

删除DevServer实例。

实时同步用户所有DevServer实例状态

实时同步用户所有DevServer实例状态。

启动DevServer实例

启动DevServer实例。

停止DevServer实例

停止DevServer实例。

创建DevServer超节点标签

创建DevServer超节点标签。

删除DevServer超节点标签

删除DevServer超节点标签。

查询DevServer超节点标签

查询DevServer超节点标签。

重装DevServer服务器操作系统镜像

重装DevServer服务器操作系统镜像。

切换DevServer服务器操作系统镜像

切换DevServer服务器操作系统镜像。

切换DevServer超节点服务器操作系统镜像

切换DevServer超节点服务器操作系统镜像。

查询用户所有超节点实例详情

查询用户所有超节点实例详情。

查询指定超节点实例详情

查询指定超节点实例详情。

删除DevServer超节点实例

删除ERROR状态的DevServer超节点实例。

重启DevServer实例

重启DevServer实例。

启动DevServer超节点服务器

启动DevServer超节点服务器。

停止DevServer超节点服务器

停止DevServer超节点服务器。

DevServer服务器挂载磁盘

DevServer服务器挂载磁盘。

DevServer服务器绑定的EIP

DevServer服务器绑定的EIP。

查询已绑定的EIP

查询已绑定的EIP。

查询资源规格列表

查询资源规格列表。

查询规格列表

查询规格列表。

查询DevServer超节点扩缩容支持规格列表及容量测算

查询DevServer超节点扩缩容支持规格列表及容量测算。

查询Hyper Cluster详情列表

查询Hyper Cluster详情列表。

创建Hyper Cluster

创建一个Hyper Cluster。

查询Hyper Cluster实例详情

查询Hyper Cluster实例详情。

删除Hyper Cluster实例

删除Hyper Cluster实例。

批量操作DevServer实例

批量操作DevServer实例。

查询DevServer Job详情

查询DevServer Job详情

查询DevServer Job列表

查询DevServer Job列表,可按照状态,id等相关字段过滤

批量删除DevServer Job

删除DevServer Job,可批量执行

创建DevServer任务

创建DevServer任务

获取DevServer Job模板列表

获取DevServer Job模板列表

获取DevServer Job模板详情

获取DevServer Job模板详情

获取DevServer插件列表

获取DevServer插件列表

获取软件信息

获取支持的软件信息,支持flavor_type和name查询参数

授权管理

表20 授权管理

API

说明

查看授权列表

查看授权列表接口用于查看授权信息。该接口适用于以下场景:当用户需要了解当前的授权情况、审核权限分配或管理权限时,可通过此接口查看授权列表。使用该接口的前提条件是用户具备查看授权的权限。查看操作完成后,将返回授权列表,包括被授权的资源、授权类型以及授权内容等信息。若用户无权限查看或授权列表不存在,接口将返回相应的错误信息。

配置授权

配置授权接口用于配置ModelArts的授权。该接口适用于以下场景:当需要为IAM子用户设置访问ModelArts的权限时,管理员可通过此接口配置授权。使用该接口的前提条件是管理员具备IAM系统的Security Administrator权限,并且需要为子用户设置访问密钥。配置完成后,子用户将被授予访问ModelArts资源的权限,从而能够正常使用训练管理、开发环境、数据管理、在线服务等功能。若管理员无权限操作或子用户不存在,接口将返回相应的错误信息。

删除授权

删除授权接口用于删除指定用户的授权或删除全量用户的授权。该接口适用于以下场景:当需要撤销特定用户的访问权限或在系统维护时清理所有用户的授权时,管理员可通过此接口删除指定用户的授权或全量用户的授权。使用该接口的前提条件是管理员具备删除授权的权限,并且需要指定要删除授权的用户或选择删除全量用户的授权。删除操作完成后,指定用户的授权将被移除,或所有用户的授权将被清空,用户将无法再访问相关功能。若用户不存在、管理员无权限操作或删除全量授权时系统检测到无管理员权限,接口将返回相应的错误信息。

创建ModelArts委托

创建ModelArts委托接口用于创建包含OBS、SWR、IEF等依赖服务的ModelArts委托。该接口适用于以下场景:当需要配置ModelArts访问OBS、SWR、IEF等服务的权限时,用户可通过此接口创建委托。使用该接口的前提条件是用户具备创建委托的权限,并且需要在IAM系统中具备相应的权限。创建完成后,ModelArts将被授权访问OBS、SWR、IEF等服务,从而能够正常执行数据存储、镜像拉取、模型部署等功能。若用户无权限创建委托或依赖服务未配置,接口将返回相应的错误信息。

工作空间管理

表21 工作空间管理

API

说明

查询工作空间详情

查询工作空间详情接口用于获取指定工作空间的详细信息。

修改工作空间

修改工作空间接口用于更新指定工作空间的配置信息。

删除工作空间

删除工作空间接口用于移除已创建的工作空间。该接口适用于以下场景:当工作空间不再需要或需要清理资源时,用户可通过此接口删除指定的工作空间。使用该接口的前提条件是工作空间已存在且用户具有删除工作空间的权限。删除操作完成后,工作空间将被永久移除,相关资源也将被清理。若工作空间不存在或用户无权限操作,接口将返回相应的错误信息。

查询工作空间配额

查询工作空间配额接口用于获取指定工作空间的资源配额信息。

修改工作空间配额

修改工作空间配额接口用于更新指定工作空间的资源配额。

查询工作空间列表

查询工作空间列表接口用于获取所有已创建的工作空间的详细信息。该接口适用于以下场景:当需要查看所有可用的工作空间或进行审计时,用户可通过此接口查询工作空间列表。使用该接口的前提条件是用户具有查看权限。查询操作完成后,系统将返回所有工作空间的详细信息,包括名称、创建时间、状态等。若用户无权限操作,接口将返回相应的错误信息。

创建工作空间

创建工作空间("default"为系统预留的默认工作空间名称,不能使用)。该接口适用于以下场景:当需要为不同的业务目标、团队或项目创建独立的工作空间时,用户可通过此接口创建新的工作空间。使用该接口的前提条件是用户具备创建工作空间的权限,并且工作空间名称未被占用且不为"default"。创建成功后,系统将为该工作空间分配默认的访问控制策略,用户可在该工作空间中进行模型开发、管理和部署等操作。若工作空间名称已存在、名称为"default"或用户无权限操作,接口将返回相应的错误信息。

查询授权模式

查询授权模式接口用于获取指定资源或功能的授权方式和权限配置信息。该接口适用于以下场景:当系统管理员需要查看资源的访问权限设置、开发者需要验证授权策略配置是否正确,或安全审计人员需要检查授权配置是否符合安全规范时,可通过此接口查询授权模式的详细信息。使用该接口的前提条件是用户具有查询权限且目标资源或功能的授权模式已配置。调用成功后,接口将返回授权模式的类型、规则及权限范围等详细信息。若用户无权限访问该接口,或目标资源的授权模式未配置,接口将返回相应的错误信息。

更新授权模式

更新授权模式接口用于修改指定资源或功能的授权方式和权限配置信息。该接口适用于以下场景:当系统管理员需要调整资源的访问权限、开发者需要更新授权策略以适应新的业务需求,或安全审计人员需要修改授权配置以符合新的安全规范时,可通过此接口更新授权模式的详细信息。使用该接口的前提条件是用户具有更新权限且目标资源或功能的授权模式已存在。调用成功后,接口将更新目标资源的授权模式,并返回更新后的授权模式信息。若用户无权限访问该接口,或目标资源的授权模式不存在,接口将返回相应的错误信息。

鉴权能否使用当前工作空间资源

鉴权能否使用当前工作空间资源接口用于验证用户是否有权限访问和使用当前工作空间中的资源。该接口适用于以下场景:当用户尝试访问或操作工作空间中的资源时,系统需要确认用户是否具有相应的权限。使用该接口的前提条件是用户已登录且工作空间已存在。鉴权成功后,用户可以正常访问和使用工作空间资源;若鉴权失败,接口将返回相应的错误信息,如用户无权限或工作空间不存在等。

查询用户角色信息

查询用户角色信息接口用于获取指定用户在系统中的角色信息。该接口适用于以下场景:当需要了解用户在系统中的权限和角色时,管理员或系统可以通过此接口查询用户的角色信息。使用该接口的前提条件是用户已存在且系统中已定义了角色信息。查询操作完成后,接口将返回用户的角色列表;若用户不存在或系统中未定义角色信息,接口将返回相应的错误信息。

查询用户列表

查询用户列表接口用于获取系统中用户的列表信息。该接口适用于以下场景:当需要查看系统中所有用户或根据特定条件筛选用户时,管理员或系统可以通过此接口查询用户列表。使用该接口的前提条件是用户已存在且查询者具有相应的权限。查询操作完成后,接口将返回符合条件的用户列表;若系统中无用户或查询者无权限操作,接口将返回相应的错误信息。

节点配置模板

表22 节点配置模板

API

说明

查询节点配置模板

查询节点配置模板接口用于获取指定节点配置模板的详细信息。该接口适用于以下场景:当用户需要查看节点配置模板的内容、管理节点配置或进行相关操作时,可通过此接口获取指定节点配置模板的详细信息。使用该接口的前提条件是节点配置模板已存在且用户具有相应的访问权限。调用该接口后,系统将返回指定节点配置模板的详细信息,包括模板名称、版本、配置参数及描述等。若节点配置模板不存在或用户无权限访问,接口将返回相应的错误信息。

配额管理

表23 配额管理

API

说明

查询OS的配额

查询OS配额接口用于获取ModelArts OS服务中部分资源的配额信息,如资源池配额、网络配额等。该接口适用于以下场景:当需要了解资源池或网络资源的使用限制、规划资源分配或监控资源使用情况时,用户可通过此接口获取相关配额信息。使用该接口的前提条件是ModelArts OS服务已部署且用户具有相应的权限(如管理员权限或资源管理权限)。调用接口成功后,系统将返回资源池配额、网络配额等详细信息,帮助用户更好地进行资源规划和管理。若用户无权限访问该接口、服务不可用或配额信息未配置,接口将返回相应的错误信息。

资源标签管理

表24 资源标签管理

API

说明

查询资源池的所有标签

查询资源池所有标签接口用于获取用户当前项目下资源池的所有标签信息,默认查询所有工作空间,但无权限的工作空间不会返回标签数据。该接口适用于以下场景:当需要管理、分类或统计资源池的标签信息时,用户可通过此接口获取资源池的标签数据。使用该接口的前提条件是用户具有访问资源池的权限且资源池已存在。调用接口成功后,系统将返回用户当前项目下所有可访问工作空间的资源池标签信息。若用户无权限访问资源池、资源池不存在或项目未创建,接口将返回相应的错误信息。

查询资源池上的标签

查询资源池的标签接口用于获取指定资源池的标签信息。该接口适用于以下场景:当需要查看、管理或统计特定资源池的标签信息时,用户可通过此接口获取资源池的标签数据。使用该接口的前提条件是资源池已存在且用户具有访问该资源池的权限。调用接口成功后,系统将返回指定资源池的标签信息,包括标签键和标签值。若资源池不存在、用户无权限访问或资源池未配置标签,接口将返回相应的错误信息。

节点池管理

表25 节点池管理

API

说明

查询节点池列表

查询节点池列表接口用于获取指定节点池的列表信息。该接口适用于以下场景:当需要查看节点池的配置、状态或管理节点池资源时,用户可通过此接口获取节点池的详细信息。使用该接口的前提条件是节点池已存在且用户具有管理员权限。调用接口成功后,系统将返回节点池的列表,包括节点池ID、名称、节点数量、状态等详细信息。若节点池不存在、用户无权限操作或节点池当前不可用,接口将返回相应的错误信息。

创建节点池

创建节点池接口用于创建新的节点池。该接口适用于以下场景:当需要扩展计算资源、优化资源分配或部署新的服务时,用户可通过此接口创建指定配置的节点池。使用该接口的前提条件是用户具有管理员权限且节点池的配置参数(如节点数量、规格、网络配置等)已正确设置。创建操作完成后,节点池将被成功创建并处于可用状态,相关节点信息将被记录。若用户无权限操作、配置参数错误或系统资源不足,接口将返回相应的错误信息。

查询指定节点池详情

查询指定节点池详情接口用于获取指定节点池的详细信息。该接口适用于以下场景:当需要查看节点池的配置、状态、资源使用情况或管理节点池时,用户可通过此接口获取节点池的详细信息。使用该接口的前提条件是节点池已存在且用户具有访问该节点池的权限。调用接口成功后,系统将返回节点池的详细信息,包括节点池ID、名称、节点数量、状态、创建时间、配置参数等。若节点池不存在、用户无权限访问或节点池当前不可用,接口将返回相应的错误信息。

更新节点池

更新节点池接口用于修改指定节点池的配置信息。该接口适用于以下场景:当需要扩展节点池容量、调整节点规格、优化资源分配或修复节点池配置时,用户可通过此接口更新节点池的相关信息。使用该接口的前提条件是节点池已存在且用户具有管理员权限。更新操作完成后,节点池的配置将被更新,包括节点数量、规格、网络配置等参数。若节点池不存在、用户无权限操作或配置参数错误,接口将返回相应的错误信息。

删除节点池

删除节点池接口用于移除已创建的节点池,包周期资源池不支持。该接口适用于以下场景:当节点池完成任务、配置错误或需要清理资源时,用户可通过此接口删除指定的节点池。使用该接口的前提条件是节点池已存在且用户具有管理员权限。删除操作完成后,节点池将被永久移除,相关资源和配置也将被清理。若节点池不存在、用户无权限操作或节点池处于不可删除状态(如包周期资源池或节点池正在使用中),接口将返回相应的错误信息。

查询节点池的节点列表

查询节点池的节点列表接口用于获取指定节点池中所有节点的详细信息。该接口适用于以下场景:当需要查看节点池的节点状态、资源使用情况或管理节点资源时,用户可通过此接口获取节点池中节点的详细信息。使用该接口的前提条件是节点池已存在且用户具有访问该节点池的权限。调用接口成功后,系统将返回节点池中所有节点的列表,包括节点ID、名称、状态、IP地址、资源使用情况等详细信息。若节点池不存在、用户无权限访问或节点池当前不可用,接口将返回相应的错误信息。

订单管理

表26 订单管理

API

说明

查询订单详情

查询订单详情接口用于获取指定订单的详细信息。该接口适用于以下场景:当需要查看订单的状态、金额、商品信息或处理订单相关问题时,用户可通过此接口获取订单的详细数据。使用该接口的前提条件是订单已存在且用户具有访问该订单的权限。调用接口成功后,系统将返回订单的详细信息,包括订单号、商品列表、金额、支付状态、下单时间等。若订单不存在、用户无权限访问或订单信息未正确配置,接口将返回相应的错误信息。

插件管理

表27 插件管理

API

说明

创建插件

创建插件实例接口用于在系统中创建一个新的插件实例。该接口适用于以下场景:当需要扩展系统功能、部署新的插件、更新现有插件配置或测试插件时,用户可通过此接口创建指定插件的实例。使用该接口的前提条件是插件已存在且用户具有管理员权限或插件管理权限。创建操作完成后,插件实例将被成功创建并处于可用状态,相关配置信息将被记录。若插件不存在、用户无权限操作、配置参数错误或系统资源不足,接口将返回相应的错误信息。

查询插件列表

查询插件实例列表接口用于获取系统中已部署的插件实例信息。该接口适用于以下场景:当用户需要查看系统中已部署的插件实例、监控插件运行状态、管理插件配置或进行故障排查时,可通过此接口获取插件实例的详细信息。使用该接口的前提条件是用户具有查询权限且系统中已部署至少一个插件实例。调用该接口后,系统将返回所有插件实例的列表,包括插件名称、类型、状态、版本及部署环境等信息。若用户无权限访问或系统中未部署任何插件实例,接口将返回相应的错误信息或空列表。

任务管理

表28 任务管理

API

说明

查询任务列表

查询任务列表接口用于获取当前用户下的任务列表。该接口适用于以下场景:当需要查看任务状态、管理任务进度或统计任务数量时,用户可通过此接口获取当前用户下所有任务的详细信息。使用该接口的前提条件是用户已登录系统且具有查看任务的权限。调用接口成功后,系统将返回当前用户下的任务列表,包括任务ID、名称、状态、创建时间等信息。若用户未登录、无权限访问或系统中未配置任务,接口将返回相应的错误信息。

计划事件

表29 计划事件

API

说明

计划事件授权

计划事件授权接口用于为指定的计划事件分配或调整权限。该接口适用于以下场景:当创建新的计划事件、调整现有计划事件的权限设置或变更权限分配时,用户可通过此接口为指定的计划事件授予或修改权限。使用该接口的前提条件是计划事件已存在且用户具有管理员权限。授权操作完成后,计划事件的权限设置将被更新,相关变更将被记录以便审计。若计划事件不存在、用户无权限操作或授权信息格式不正确,接口将返回相应的错误信息。

查询计划事件列表

查询计划事件列表信息。