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资源的标签,支持批量删除。 |
||
镜像管理 |
根据指定条件分页查询满足条件的所有镜像。 |
|
将用户自定义的镜像注册到modelarts镜像管理。 |
||
查询用户镜像信息概览,以镜像名称作为聚合的信息。 |
||
查询镜像详情。 |
||
删除镜像对象,对于个人私有镜像可以通过参数一并删除swr镜像内容。 |
训练管理接口
api |
说明 |
---|---|
创建一个算法。 |
|
查询算法列表。 |
|
根据算法id查询指定算法。 |
|
更新算法。 |
|
删除算法。 |
|
查询超参搜索算法列表。 |
api |
说明 |
---|---|
创建训练作业。 |
|
查询训练作业详情。 |
|
更新训练作业描述。 |
|
删除训练作业。 |
|
终止训练作业,只可终止创建中、等待中、运行中的作业。 |
|
查询训练作业指定任务的日志(预览)。 |
|
查询训练作业指定任务的日志(obs链接),可全量查看或直接下载。 |
|
查询训练作业指定任务的运行指标。 |
|
根据指定查询条件查询用户创建的训练作业列表。 |
|
查询超参搜索所有trial的结果。 |
|
根据传入的trial_id,查询指定trial的搜索结果。 |
|
获取超参敏感度分析结果的汇总表。 |
|
获取某个超参敏感度分析图像的保存路径。 |
|
提前终止自动化搜索作业的某个trial。 |
|
获取自动化搜索作业yaml模板的信息。 |
|
获取自动化搜索作业yaml模板的内容。 |
api |
说明 |
---|---|
创建训练作业标签,支持批量添加,当添加的标签key已存在,则覆盖该标签的value。 |
|
删除训练作业标签,支持批量删除。 |
|
查询训练作业标签。 |
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 |
说明 |
---|---|
部署服务。 |
|
查询服务列表。 |
|
查询服务详情,根据服务id查询服务详情。 |
|
启动停止边缘节点服务实例。 |
|
更新模型服务。 |
|
查询服务监控信息。 |
|
查询实时服务更新日志。 |
|
查询服务事件日志,包含服务的操作记录及部署过程中的关键动作、部署失败原因。 |
|
删除服务。 |
|
查询支持的服务部署规格列表。 |
|
查询专属资源池列表。 |
资源管理接口
api |
说明 |
---|---|
获取modelarts os服务的配置参数,如网络网段,用户资源配额等。 |
api |
说明 |
---|---|
获取指定插件模板的详细信息。 |
api |
说明 |
---|---|
查询资源池中的节点列表。 |
|
批量删除指定资源池中的节点,资源池中至少保留一个节点。 |
api |
说明 |
---|---|
查询事件列表。 |
api |
说明 |
---|---|
创建网络资源。 |
|
查询网络资源列表。 |
|
查询指定网络资源的详情信息。 |
|
删除指定网络资源。 |
|
更新指定网络资源。 |
api |
说明 |
---|---|
查询当前项目下所有资源池的实时利用率。 |
api |
说明 |
---|---|
用户创建资源池。 |
|
查询资源池列表。 |
|
查询指定资源池的详细信息。 |
|
删除指定的资源池。 |
|
更新指定的资源池。 |
|
获取资源池的监控信息。 |
|
获取资源池的统计信息。 |
api |
接口 |
---|---|
查询资源规格列表。 |
api |
说明 |
---|---|
查询专属资源池作业列表。 |
|
查询专属资源池作业统计信息。 |
devserver管理接口
api |
说明 |
---|---|
查询用户所有devserver实例详情。 |
|
创建devserver实例。 |
|
查询devserver实例详情。 |
|
删除devserver实例。 |
|
实时同步用户所有devserver实例状态。 |
|
启动devserver实例。 |
|
停止devserver实例。 |
授权管理接口
api |
说明 |
---|---|
查看授权列表。 |
|
配置modelarts授权。若没有授权,modelarts训练管理、开发环境、数据管理、在线服务等功能将不能正常使用。 |
|
删除指定用户的授权或者删除全量用户的授权。 |
|
创建包含obs、swr、ief等依赖服务的modelarts委托。 |
工作空间管理接口
api |
说明 |
---|---|
查询工作空间列表,响应消息体中包含详细信息。 |
|
创建工作空间。 |
|
查询工作空间详情。 |
|
修改工作空间。 |
|
删除工作空间。 |
|
查看工作空间配额。 |
|
修改工作空间配额。 |
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨