获取资产列表
功能介绍
获取资产列表。
URI
GET /v1/{project_id}/assets
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
categories |
否 |
String |
参数解释: 资产类别,支持IMAGE/APP/WORKFLOW/DATASET,支持查询多个,以“,”分割。 约束限制: 不涉及 取值范围: 长度范围为0到2000个字符。 默认取值: 不涉及 |
key_word |
否 |
String |
参数解释: 关键字,支持在资产名、资产标题、短描述、长描述中搜索。 约束限制: 不涉及 取值范围: 长度范围为0到2000个字符。 默认取值: 不涉及 |
labels |
否 |
String |
参数解释: 标签,支持查询多个,以“,”分割。 约束限制: 不涉及 取值范围: 长度范围为0到2000个字符。 默认取值: 不涉及 |
domains |
否 |
String |
参数解释: 领域,支持查询多个,以“,”分割。 约束限制: 不涉及 取值范围: 长度范围为0到2000个字符。 默认取值: 不涉及 |
limit |
否 |
Integer |
参数解释: 返回记录限制。 约束限制: 不涉及 取值范围: 取值范围为[1,1000]。 默认取值: 100 |
offset |
否 |
Integer |
参数解释: 偏移量。 约束限制: 不涉及 取值范围: 取值范围为[0,100000000]。 默认取值: 0 |
publishers |
否 |
String |
参数解释: 发布者,支持查询多个,以“,”分割。 约束限制: 不涉及 取值范围: 长度范围为0到2000个字符。 默认取值: 不涉及 |
scope |
是 |
String |
参数解释: 查询范围。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
vendor_ids |
否 |
String |
参数解释: 供应商,支持查询多个,以“,”分割。 约束限制: 不涉及 取值范围: 长度范围为0到2000个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
参数解释: 资产总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
assets |
Array of GetAssetRsp objects |
参数解释: 资产列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 资产ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
category |
String |
参数解释: 类别。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
domain |
String |
参数解释: 领域。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
String |
参数解释: 资产名。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
title |
String |
参数解释: 资产展示名。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels |
Array of strings |
参数解释: 资产标签列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
picture |
String |
参数解释: 资产封面图访问链接。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
vendor_id |
String |
参数解释: 供应商ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
versions |
Array of VersionRsp objects |
参数解释: 资产版本号列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_time |
String |
参数解释: 创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
update_time |
String |
参数解释: 更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
stars |
Integer |
参数解释: 收藏数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
subscribes |
Integer |
参数解释: 订阅数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
version |
String |
参数解释: 资产版本号。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
publisher |
String |
参数解释: 发布者。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
description |
String |
参数解释: 资产长描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
summary |
String |
参数解释: 资产短描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
license |
String |
参数解释: 许可证。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
status |
String |
参数解释: 资产状态。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
failed_reason |
String |
参数解释: 资产发布失败原因。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels |
Array of strings |
参数解释: 资产标签列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
picture |
String |
参数解释: 资产封面图访问链接。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_time |
String |
参数解释: 创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
update_time |
String |
参数解释: 更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询资产列表。
https://{endpoint}/v1/{project_id}/assets
响应示例
状态码:200
OK
{ "count" : 15, "assets" : [ { "id" : "aa78f595-5acb-4be8-b277-229be335633a", "category" : "WORKFLOW", "name" : "kno2d-ns", "title" : "KNO2D-NS", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "https://{endpoint}/assets/metadata/picture.png", "vendor_id" : "00000000000000000000000000000000", "versions" : [ { "version" : "1.0.0", "description" : "", "summary" : "summary", "license" : "", "status" : "NORMAL", "failed_reason" : "internal error", "labels" : [ "molecular docking", "drug discovery", "smallMolecularChemicals" ], "picture" : "https://{endpoint}/assets/metadata/picture.png", "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z" } ], "create_time" : "2021-09-07T05:44:28Z", "update_time" : "2021-09-07T05:44:28Z", "stars" : 0, "subscribes" : 1 } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。