API概览

ModelArts服务所提供的接口均为自研接口。

通过ModelArts服务自研接口，您可以使用ModelArts数据集管理、训练管理、模型管理及服务管理功能。

数据管理接口

数据管理接口包括数据集管理、数据集版本管理、样本管理、标签管理等，通过这些接口可以创建数据集并完成数据标注，具体接口信息请参见数据管理接口概述。

开发环境接口

表1 开发环境（推荐）
类型	API	说明
开发环境实例管理	查询支持的镜像列表	根据指定条件分页查询满足条件的所有镜像。
	查询Notebook实例列表	可按需查询满足条件的开发环境实例列表。
	创建Notebook实例	根据指定的实例规格、AI引擎镜像、存储等相关参数，创建一个开发环境实例。
	打开CodeLab实例	打开CodeLab实例。
	查询Notebook实例详情	查询开发环境实例详情。
	更新Notebook实例	更新开发环境实例。
	删除Notebook实例	删除开发环境实例，删除的资源包括Notebook容器以及对应的所有存储资源。
	查询支持可切换规格列表	查询Notebook实例可切换的规格列表。
	查询运行中的开发环境可用时长	查询运行中的开发环境可用时长。
	Notebook时长续约	延长运行中的开发环境时长。
	启动Notebook实例	启动Notebook实例。
	停止Notebook实例	停止Notebook实例。
动态挂载OBS	获取动态挂载OBS实例信息列表	获取动态挂载OBS实例信息列表。
	动态挂载OBS	在运行态Notebook实例，动态挂载OBS。
	获取动态挂载OBS实例详情	获取动态挂载OBS实例详情。
	动态卸载OBS	动态卸载OBS。

表2 开发环境接口（旧版）
API	说明
创建开发环境实例	创建开发环境实例，用于代码开发。
查询开发环境实例列表	查询开发环境实例列表，用户可按需查询满足条件的开发环境实例列表。
查询开发环境实例详情	查询开发环境实例详情。
更新开发环境实例信息	更新开发环境实例的描述信息。
删除开发环境实例	删除开发环境实例。
管理开发环境实例	启动和停止开发环境实例。

训练管理接口

表3 算法管理接口
API	说明
创建算法	创建一个算法。
查询算法列表	查询算法列表。
查询算法详情	根据算法ID查询指定算法。
更新算法	更新算法。
删除算法	删除算法。
查询超参搜索算法列表	查询超参搜索算法列表。

表4 训练作业管理接口
API	说明
创建训练作业	创建训练作业。
查询训练作业详情	查询训练作业详情。
更新训练作业描述	更新训练作业描述。
删除训练作业	删除训练作业。
终止训练作业	终止训练作业，只可终止创建中、等待中、运行中的作业。
查询训练作业指定任务的日志（预览）	查询训练作业指定任务的日志（预览）。
查询训练作业指定任务的日志（OBS链接）	查询训练作业指定任务的日志（OBS链接），可全量查看或直接下载。
查询训练作业指定任务的运行指标	查询训练作业指定任务的运行指标。
查询训练作业列表	根据指定查询条件查询用户创建的训练作业列表。
查询超参搜索所有trial的结果	查询超参搜索所有trial的结果。
查询超参搜索某个trial的结果	根据传入的trial_id，查询指定trial的搜索结果。
获取超参敏感度分析结果	获取超参敏感度分析结果的汇总表。
获取某个超参敏感度分析图像的路径	获取某个超参敏感度分析图像的保存路径。
提前终止自动化搜索作业的某个trial	提前终止自动化搜索作业的某个trial。
获取自动化搜索作业yaml模板的信息	获取自动化搜索作业yaml模板的信息。
获取自动化搜索作业yaml模板的内容	获取自动化搜索作业yaml模板的内容。

表5 资源和引擎规格接口
API	说明
查询训练作业支持的公共规格列表	查询训练作业支持的公共规格列表。
查询训练作业支持的AI引擎列表	查询训练作业支持的AI引擎列表。

表6 训练管理接口（旧版）
类型	API	说明
训练作业	创建训练作业	创建一个训练作业。
	查询训练作业列表	根据指定条件查询用户创建的训练作业。
	查询训练作业版本详情	根据作业ID查看指定的训练作业详情。
	删除训练作业版本	删除训练作业一个版本。
	查询训练作业版本列表	根据作业ID查看指定的训练作业版本。
	创建训练作业版本	创建一个训练作业版本。
	停止训练作业版本	停止训练作业。
	更新训练作业描述	更新训练作业的描述。
	删除训练作业	删除训练作业。
	获取训练作业日志的文件名	获取训练作业日志的文件名。
	查询预置算法	查看预置模型的详情。
	查询训练作业日志	按行来查询训练作业日志详细信息。
训练作业参数配置	创建训练作业参数	创建训练作业参数。
	查询训练作业参数列表	根据指定条件查询用户创建的训练作业参数。
	更新训练作业参数	更新训练作业参数。
	删除训练作业参数	删除训练作业参数。
	查询训练作业参数详情	查看指定的训练作业参数详情。
可视化作业管理	创建可视化作业	创建可视化作业。
	查询可视化作业列表	根据指定条件查询用户创建的可视化作业列表。
	查询可视化作业详情	根据作业名称查看指定的可视化作业详情。
	更新可视化作业描述	更新可视化作业的描述。
	删除可视化作业	删除可视化作业。
	停止可视化作业	停止可视化作业。
	重启可视化作业	重启可视化作业。
资源和引擎规格接口	查询作业资源规格	查看指定作业类型的资源规格。
资源和引擎规格接口	查询作业引擎规格	查看指定作业的引擎类型和版本。
作业状态参考	作业状态参考	查看作业状态值和作业状态说明。

模型管理接口

表7 模型管理接口
API	说明
导入模型	导入模型。
查询模型列表	查询模型列表，可以根据不同的检索参数进行查询。
查询模型详情	查询模型详情，根据模型ID查询模型的详细信息。
删除模型	删除模型，根据模型ID删除指定模型，可以级联删除该模型下的所有版本。

服务管理接口

表8 服务管理接口
API	说明
部署服务	部署模型服务。
查询服务列表	查询模型服务列表。
查询服务详情	查询模型服务详情，根据服务ID查询服务详情。
启动停止边缘节点服务实例	启动停止边缘节点服务实例。
更新服务配置	更新模型服务。
查询服务监控信息	查询服务监控信息。
查询服务更新日志	查询实时服务更新日志。
查询服务事件日志	查询服务事件日志，包含服务的操作记录及部署过程中的关键动作、部署失败原因。
删除服务	删除模型服务。
查询支持的服务部署规格	查询支持的服务部署规格列表。
查询专属资源池列表	查询专属资源池列表。

授权管理接口

表9 工作空间管理接口
API	说明
查看授权列表	查看授权列表。
配置授权	配置ModelArts授权。若没有授权，ModelArts训练管理、开发环境、数据管理、在线服务等功能将不能正常使用。
删除授权	删除指定用户的授权或者删除全量用户的授权。
创建ModelArts委托	创建包含OBS、SWR、IEF等依赖服务的ModelArts委托。

工作空间管理接口

**表10** 工作空间管理接口
API	说明
查询工作空间列表	查询工作空间列表，响应消息体中包含详细信息。
创建工作空间	创建工作空间。
查询工作空间详情	查询工作空间详情。
修改工作空间	修改工作空间。
删除工作空间	删除工作空间。
查询工作空间配额	查看工作空间配额。
修改工作空间配额	修改工作空间配额。

上一篇：基本概念

下一篇：如何调用API

API概览

数据管理接口

开发环境接口

训练管理接口

模型管理接口

服务管理接口

授权管理接口

工作空间管理接口

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

0元

专业服务

退订

建议反馈

售前咨询热线