API概览
ModelArts服务所提供的接口均为自研接口。
通过ModelArts服务自研接口，您可以使用ModelArts Workflow、开发环境、训练管理、AI应用管理及服务管理功能。
工作流管理
|
API |
说明 |
|---|---|
|
获取Workflow列表信息。 |
|
|
创建Workflow。 |
|
|
通过ID删除Workflow。 |
|
|
通过ID查询Workflow详情。 |
|
|
更新Workflow信息。 |
|
|
获取Workflow统计信息。 |
|
|
获取Workflow待办列表。 |
|
|
计费工作流在线主服务鉴权。 |
|
|
计费工作流购买资源。 |
|
API |
说明 |
|---|---|
|
查询Workflow下的执行记录列表。 |
|
|
创建工作流执行。 |
|
|
通过ID删除Execution。 |
|
|
通过ID，查询Execution详情。 |
|
|
通过ID更新Execution。 |
|
|
操作Execution。 |
|
|
操作STEP。 |
|
|
获取工作流节点的度量信息。 |
|
API |
说明 |
|---|---|
|
创建工作消息订阅。 |
|
|
删除消息订阅。 |
|
|
查询订阅信息。 |
|
|
更新订阅信息。 |
|
API |
说明 |
|---|---|
|
创建Workflow定时调度。 |
|
|
查询工作流调度详情。 |
|
|
删除工作流调度信息。 |
|
|
更新WorkflowSchedule信息。 |
开发环境接口
|
类型 |
API |
说明 |
|---|---|---|
|
开发环境实例管理 |
可按需查询满足条件的开发环境实例列表。 |
|
|
根据指定的实例规格、AI引擎镜像、存储等相关参数，创建一个开发环境实例。 |
||
|
查询开发环境实例详情。 |
||
|
更新开发环境实例。 |
||
|
删除开发环境实例，删除的资源包括Notebook容器以及对应的所有存储资源。 |
||
|
运行的实例可以保存成容器镜像，保存的镜像中，安装的依赖包（pip包）不丢失，VSCode远程开发场景下，在Server端安装的插件不丢失。 |
||
|
查询支持的有效规格列表。 |
||
|
查询Notebook实例可切换的规格列表。 |
||
|
查询运行中的开发环境可用时长。 |
||
|
延长运行中的开发环境时长。 |
||
|
启动Notebook实例。 |
||
|
停止Notebook实例。 |
||
|
动态挂载OBS |
获取动态挂载OBS实例信息列表。 |
|
|
在运行态Notebook实例，动态挂载OBS。 |
||
|
获取动态挂载OBS实例详情。 |
||
|
动态卸载OBS。 |
||
|
标签管理 |
给指定Notebook资源添加标签，支持批量添加，当添加的标签key已存在，则覆盖该标签的value。 |
|
|
删除指定Notebook资源的标签，支持批量删除。 |
||
|
查询用户当前project下Notebook实例类型下的标签，默认查询所有工作空间，无权限不返回标签数据。 |
||
|
镜像管理 |
根据指定条件分页查询满足条件的所有镜像。 |
|
|
将用户自定义的镜像注册到ModelArts镜像管理。 |
||
|
查询用户镜像信息概览，以镜像名称作为聚合的信息。 |
||
|
查询镜像详情。 |
||
|
删除镜像对象，对于个人私有镜像可以通过参数一并删除SWR镜像内容。 |
训练管理接口
|
API |
说明 |
|---|---|
|
创建一个算法。 |
|
|
查询算法列表。 |
|
|
根据算法ID查询指定算法。 |
|
|
更新算法。 |
|
|
删除算法。 |
|
|
查询超参搜索算法列表。 |
|
API |
说明 |
|---|---|
|
创建训练实验。 |
|
API |
说明 |
|---|---|
|
创建训练作业。 |
|
|
查询训练作业详情。 |
|
|
更新训练作业描述。 |
|
|
删除训练作业。 |
|
|
终止训练作业，只可终止创建中、等待中、运行中的作业。 |
|
|
查询训练作业指定任务的日志（预览）。 |
|
|
查询训练作业指定任务的日志（OBS链接），可全量查看或直接下载。 |
|
|
查询训练作业指定任务的运行指标。 |
|
|
根据指定查询条件查询用户创建的训练作业列表。 |
|
|
查询超参搜索所有trial的结果。 |
|
|
根据传入的trial_id，查询指定trial的搜索结果。 |
|
|
获取超参敏感度分析结果的汇总表。 |
|
|
获取某个超参敏感度分析图像的保存路径。 |
|
|
提前终止自动化搜索作业的某个trial。 |
|
|
获取自动化搜索作业yaml模板的信息。 |
|
|
获取自动化搜索作业yaml模板的内容。 |
|
API |
说明 |
|---|---|
|
创建训练作业标签，支持批量添加，当添加的标签key已存在，则覆盖该标签的value。 |
|
|
删除训练作业标签，支持批量删除。 |
|
|
查询训练作业标签。 |
|
API |
说明 |
|---|---|
|
获取训练作业事件列表。 |
|
API |
说明 |
|---|---|
|
创建训练作业镜像保存任务。 |
|
|
查询训练作业镜像保存任务。 |
|
|
获取用户的训练配额。 |
|
API |
说明 |
|---|---|
|
获取训练作业支持的公共规格。 |
|
|
获取训练作业支持的AI预置框架。 |
AI应用管理接口
|
API |
说明 |
|---|---|
|
查询模型AI引擎以及runtime。 |
|
|
创建AI应用。 |
|
|
查询AI应用列表，可以根据不同的检索参数进行查询。 |
|
|
查询AI应用详情，根据AI应用ID查询AI应用的详细信息。 |
|
|
删除AI应用，根据AI应用ID删除指定AI应用，可以级联删除该AI应用下的所有版本。 |
APP认证管理接口
|
API |
说明 |
|---|---|
|
获取APIG APP基本信息列表，用户只能获取自己创建的APP信息。 |
|
|
创建API网关应用（简称APP）。 |
|
|
查询指定的APP详情。 |
|
|
删除指定的APP。 |
|
|
为指定API网关应用创建新的AppCode。 |
|
|
重置指定API网关应用的指定的AppCode。 |
|
|
删除指定API网关应用的指定的AppCode。 |
|
|
重置指定API网关应用的AppSecret。 |
|
|
获取用户绑定APP的API列表。 |
|
|
注册API并将API授权给APP。 |
|
|
删除指定的API，只有对API所属服务有删除权限的用户才可以删除API。 |
|
|
将指定的API授权给APP。 |
|
|
更新API的授权关系。 |
|
|
解除指定的API对APP的授权。 |
|
|
获取指定的API与APP授权关系列表。 |
|
|
创建API，未将API授权给APP。 |
|
|
查询指定API详情。 |
|
|
查询服务授权的API、APP信息。 |
|
|
查询APP的API认证信息。 |
|
|
查询APP是否存在。 |
服务管理接口
|
API |
说明 |
|---|---|
|
通过patch操作对服务进行更新。 |
|
|
查询服务监控信息。 |
|
|
查询服务列表。 |
|
|
部署服务。 |
|
|
查询支持的服务部署规格列表。 |
|
|
查询服务详情，根据服务ID查询服务详情。 |
|
|
更新模型服务配置。 |
|
|
删除服务。 |
|
|
更新模型服务的单个属性，目前只支持instance_count(更新模型服务实例数量)，仅运行中、告警、异常状态下的在线服务可以执行该操作。 |
|
|
查询专属资源池列表。 |
|
|
查询服务事件日志，包含服务的操作记录及部署过程中的关键动作、部署失败原因。 |
|
|
启动停止边缘节点服务实例。 |
|
|
查询实时服务更新日志。 |
|
|
给指定服务添加标签（目前只支持在线服务），当添加的标签key已存在，则覆盖该标签的value。 |
|
|
删除服务（目前只支持在线服务）的标签，支持批量删除。 |
|
|
查询当前项目下的推理服务标签，默认查询所有工作空间，无权限不返回标签数据。 |
|
|
该接口用于查询推理VPC访问通道。 |
资源管理接口
|
API |
说明 |
|---|---|
|
获取ModelArts OS服务的配置参数，如网络网段，用户资源配额等。 |
|
API |
说明 |
|---|---|
|
获取指定插件模板的详细信息。 |
|
API |
说明 |
|---|---|
|
查询资源池中的节点列表。 |
|
|
批量删除指定资源池中的节点，资源池中至少保留一个节点。 |
|
|
批量对节点功能上锁，被上锁的功能在控制台不能正常使用。 |
|
|
批量对节点功能解锁，被上锁的功能在控制台不能正常使用，解锁后恢复正常。 |
|
|
批量重启指定资源池中的节点。 |
|
API |
说明 |
|---|---|
|
查询事件列表。 |
|
API |
说明 |
|---|---|
|
创建网络资源。 |
|
|
查询网络资源列表。 |
|
|
查询指定网络资源的详情信息。 |
|
|
删除指定网络资源。 |
|
|
更新指定网络资源。 |
|
API |
说明 |
|---|---|
|
查询当前项目下所有资源池的实时利用率。 |
|
API |
说明 |
|---|---|
|
用户创建资源池。 |
|
|
查询资源池列表。 |
|
|
查询指定资源池的详细信息。 |
|
|
删除指定的资源池。 |
|
|
更新指定的资源池。 |
|
|
获取资源池的监控信息。 |
|
|
获取资源池的统计信息。 |
|
API |
接口 |
|---|---|
|
查询资源规格列表。 |
|
API |
说明 |
|---|---|
|
查询专属资源池作业列表。 |
|
|
查询专属资源池作业统计信息。 |
Lite Server管理接口
|
API |
说明 |
|---|---|
|
查询用户所有DevServer实例列表。 |
|
|
创建DevServer。 |
|
|
查询DevServer实例详情。 |
|
|
删除DevServer实例。 |
|
|
实时同步用户所有DevServer实例状态。 |
|
|
启动DevServer实例。 |
|
|
停止DevServer实例。 |
|
|
创建DevServer超节点标签。 |
|
|
删除DevServer超节点标签。 |
|
|
查询DevServer超节点标签。 |
|
|
重装DevServer服务器操作系统镜像。 |
|
|
切换DevServer服务器操作系统镜像。 |
|
|
切换DevServer超节点服务器操作系统镜像。 |
|
|
查询用户所有超节点实例详情。 |
|
|
删除DevServer超节点实例。 |
|
|
重启DevServer实例。 |
|
|
启动DevServer超节点服务器。 |
|
|
停止DevServer超节点服务器。 |
授权管理接口
|
API |
说明 |
|---|---|
|
查看授权列表。 |
|
|
配置ModelArts授权。若没有授权，ModelArts训练管理、开发环境、数据管理、在线服务等功能将不能正常使用。 |
|
|
删除指定用户的授权或者删除全量用户的授权。 |
|
|
创建包含OBS、SWR、IEF等依赖服务的ModelArts委托。 |
工作空间管理接口
配额管理
|
API |
说明 |
|---|---|
|
获取ModelArts OS服务中部分资源的配额，如资源池配额、网络配额等。 |
资源标签管理
|
API |
说明 |
|---|---|
|
查询用户当前项目下资源池的所有标签，默认查询所有工作空间，无权限的工作空间不返回标签数据。 |
|
|
查询指定资源池的标签。 |
