查询AI应用列表 - ListModels

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:model:list
List
model *
-
-
-
-
g:RequestTag/<tag-key>
g:TagKeys

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:model:list	List	model *	-	-	-
-	g:RequestTag/<tag-key> g:TagKeys

URI

GET /v1/{project_id}/models

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	用户项目ID。获取方法请参见获取项目ID和名称。

表2 Query参数
参数	是否必选	参数类型	描述
model_name	否	String	模型名称，可支持模糊匹配。当模型名称包含下划线时，由于下划线涉及转义处理，因此需要在请求中增加exact_match参数，且参数值设置为true，确保能够正常执行查询操作。
exact_match	否	Boolean	是否对下划线进行转义处理，当模型名称包含下划线时，需要将该参数值设置为true，确保能够正常执行查询操作。默认不填该值。
model_version	否	String	模型版本。格式需为“数值：数值：数值”，其中数值为1-2位正整数，注意：版本不可以出现例如01.01.01等以0开头的版本号形式。
model_status	否	String	模型状态，可根据模型状态执行查询。模型状态： publishing：发布中 published：已发布 failed：发布失败 building：构建镜像中 building_failed：构建失败
description	否	String	描述信息，可支持模糊匹配。
offset	否	Integer	指定要查询页的索引，默认为“0”。
limit	否	Integer	指定每一页返回的最大条目数，默认为“1000”。
sort_by	否	String	指定排序字段，枚举值如下： create_at：默认值，AI应用创建时间 model_version：AI应用版本 model_size：AI应用大小
order	否	String	排序方式，枚举值如下： asc: 递增排序 desc: 递减排序，默认值
workspace_id	否	String	工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。
model_type	否	String	模型类型，查询属于该类型的模型列表。model_type与not_model_type为互斥关系，不能同时存在。可选值为TensorFlow、PyTorch、MindSpore、Image、Custom、Template。
not_model_type	否	String	模型类型，查询不属于该类型的模型列表。可选值为TensorFlow、PyTorch、MindSpore、Image、Custom、Template。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
models	Array of ModelListItem objects	模型元数据信息。
total_count	Integer	不分页的情况下符合查询条件的总模型数量。
count	Integer	符合查询条件的模型数量。

表5 ModelListItem
参数	参数类型	描述
owner	String	模型所属租户的用户id。
model_version	String	模型版本。
model_type	String	模型类型。
description	String	模型描述信息。
project	String	模型所属租户的项目id。
source_type	String	模型来源的类型，仅当模型为自动学习部署过来时有值，取值为auto。
model_id	String	模型id。
model_source	String	模型来源。auto：自动学习；algos：预置算法；custom：自定义。
install_type	Array of strings	模型支持的部署类型列表。
model_size	Integer	模型大小，单位为字节数。
workspace_id	String	工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。
model_status	String	模型状态。
market_flag	Boolean	标识模型是否来自市场。
tunable	Boolean	标识模型是否支持二次调优。true表示支持，false表示不支持。
model_name	String	模型名称。
create_at	Long	模型创建时间，距“1970.1.1 0:0:0 UTC”毫秒数。
publishable_flag	Boolean	标识模型是否可发布至市场。
source_copy	String	镜像复制开关，仅当“model_type”为“Image”时有效。 true：表示复制镜像模式，无法极速创建AI应用，SWR源目录中的镜像更改或删除不影响服务部署。 false：表示不复制镜像模式，可极速创建AI应用，更改或删除SWR源目录中的镜像会影响服务部署。不设置值时，默认为复制镜像模式。
tenant	String	模型所属租户的账号id。
subscription_id	String	模型订阅ID。
extra	String	扩展字段。
specification	ModelSpecification object	部署规格
deployment_constraints	DeploymentConstraints object	部署约束

表6 ModelSpecification
参数	参数类型	描述
min_cpu	String	最小CPU规格。
min_gpu	String	最小GPU规格。
min_memory	String	最小内存。
min_ascend	String	最小Ascend规格。

表7 DeploymentConstraints
参数	参数类型	描述
accelerators	Array of Accelerator objects	支持的加速卡类型。自定义镜像导入时，仅支持一种类型
cpu_type	String	cpu类型
input_types	Array of strings	在异步模式、视频业务场景下使用，表示输入输出类型如OBS,VIS。为自定义镜像导入使用，非自定义进行在runtime声明
output_types	Array of strings	在异步模式、视频业务场景下使用，表示输入输出类型如OBS,DIS。自定义镜像导入使用，非自定义进行在runtime声明
request_mode	String	模型部署为服务时作业的请求模型
rsa	Rsa object	用于容器与推理平台安全通信或者字段加密。自定义镜像导入使用，非自定义进行在runtime声明
service_config	String	服务部署字段声明，服务部署时可指定具体的值。自定义镜像导入使用，非自定义进行在runtime声明。由于结构较为复杂，该值为xml格式
task_config	String	作业相关的配置字段声明，作业创建时可指定具体的值。自定义镜像导入使用，非自定义进行在runtime声明。由于结构较为复杂，该值为xml格式
model_security	ModelSecurity object	模型加解密参数

表8 Accelerator
参数	参数类型	描述
type	String	加速卡类型，目前共三种： npu gpu none
name	String	加速卡名称，如SNT9B。
cuda_version	String	cuda驱动版本。
driver_version_section	String	驱动版本集合。

表9 Rsa
参数	参数类型	描述
mode	String	加密模式
private_key	String	私钥
public_key	String	公钥

**表10** ModelSecurity
参数	参数类型	描述
model_key	String	使用Edge加密模型后，可获取Root Key和modelKey，以及加密后的模型
root_key	String	使用Edge加密模型后，可获取Root Key和modelKey，以及加密后的模型
security_policy	String	模型加密方式
is_verify_app	Boolean	Edge边缘场景，是否校验技能中的文件，包括配置文件、容器镜像、库文件等。

请求示例

GET https://{endpoint}/v1/{project_id}/models

响应示例

状态码：200

模型列表

{
  "total_count" : 1,
  "count" : 1,
  "models" : [ {
    "model_name" : "mnist",
    "model_version" : "1.0.0",
    "model_id" : "10eb0091-887f-4839-9929-cbc884f1e20e",
    "model_type" : "tensorflow",
    "model_size" : 5012312,
    "tenant" : "6d28e85aa78b4e1a9b4bd83501bcd4a1",
    "project" : "d04c10db1f264cfeb1966deff1a3527c",
    "owner" : "6d28e85aa78b4e1a9b4bd83501bcd4a1",
    "create_at" : 1533041553000,
    "description" : "mnist model",
    "workspace_id" : "0",
    "specification" : { }
  } ]
}