获取模型列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求语法
GET /api/v1/models
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 否 | 模型列表的页码。起始值为1，默认为1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页显示的模型数量，默认为10。 | 10 |
| Order | string | 否 | 分页查询时，对指定的排序字段进行升序或降序。默认ASC。
| DESC |
| SortBy | string | 否 | 分页查询时的排序字段。目前使用GmtCreateTime字段用于排序。 | GmtCreateTime |
| WorkspaceId | string | 否 | 配置工作空间ID，返回列表中只获取该工作空间内的模型列表。如何获取工作空间ID，请参见ListWorkspaces。 | 324** |
| ModelName | string | 否 | 配置模型名称，用来过滤获取的模型列表。 | 情感分析 |
| Label | string | 否 | 标签串。用于列表过滤，标签中key或value中，有指定字符串的，都会被过滤出来。 | key1 |
| Provider | string | 否 | 提供者。指定提供者，则只返回该提供者公开的模型。不填则返回用户自己的模型。 | pai |
| Domain | string | 否 | 配置领域来过滤该领域内的模型列表。例如：nlp（自然语言处理）、cv（计算机视觉）等。 | nlp |
| Task | string | 否 | 配置任务来过滤属于该任务类型的模型列表。例如：text-classification（文本分类）等。 | text-classification |
| Origin | string | 否 | 配置模型源，来过滤属于该社区或组织的模型列表。例如ModelScope，HuggingFace等。 | ModelScope |
| Query | string | 否 | 配置查询条件。ModelName、Domain、Task、LabelKey、LabelValue相似匹配。 例如输入为nlp，则ModelName、Domain、Task、LabelKey、LabelValue中匹配的模型都会返回。 | nlp |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "5A14FA81-DD4E-******-6343FE44B941",
"Models": [
{
"ModelId": "model-1123*****",
"ModelName": "情感分析",
"GmtCreateTime": "2021-01-21T17:12:35Z",
"GmtModifiedTime": "2021-01-21T17:12:35Z",
"WorkspaceId": "234**",
"UserId": "1557702098******",
"OwnerId": "1557702098******",
"ModelDescription": "情感分析。",
"Accessibility": "PUBLIC",
"LatestVersion": {
"VersionName": "0.1.0",
"GmtCreateTime": "2021-01-21T17:12:35Z",
"GmtModifiedTime": "2021-01-21T17:12:35Z",
"UserId": "155770209******",
"OwnerId": "155770209******",
"Uri": "oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/",
"VersionDescription": "情感分析。",
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"FormatType": "SavedModel",
"FrameworkType": "TensorFlow",
"Options": "{}",
"Metrics": {
"test": "test",
"test2": 1
},
"TrainingSpec": {
"test": "test",
"test2": 1
},
"InferenceSpec": {
"test": "test",
"test2": 1
},
"SourceType": "PAIFlow",
"SourceId": "region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf",
"ApprovalStatus": ""
},
"Labels": [
{
"Key": "env",
"Value": "test"
}
],
"Origin": "ModelScope",
"Domain": "nlp",
"Task": "text-classifiaction",
"ModelDoc": "https://***.md",
"Provider": "pai"
}
],
"TotalCount": 15
}错误码
访问错误中心查看更多错误码。
