# 查询资产列表 - ListAsset #### 功能介绍 查询资产列表接口用于在ModelArts平台上查询指定项目下的资产列表。 该接口适用于以下场景：当用户需要在资产中心浏览、检索和管理资产时，可以通过此接口按需筛选所需资产。使用该接口的前提条件是用户已具备项目访问权限。平台将根据传入的查询条件返回符合条件的资产详情列表及总数。若请求参数格式错误或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListAsset)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/assets 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**：华为云项目ID，\[获取项目ID\]在ModelArts Studio任意页面，按F12进入开发者工具，刷新页面，在开发者工具Network页签找到/rest/me接口，从此接口的response里找到project_id字段。 **约束限制**：1-64字符，英文字母，数字，下划线，中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | sort_dir | 否 | String | **参数解释**：排序字段。 **约束限制**：不涉及。 **取值范围**： 枚举值： - ASC: 升序 - DESC: 降序。 **默认取值**：DESC。 | | sort_key | 否 | String | **参数解释**：排序字段。 **约束限制**：不涉及。 **取值范围**：枚举值： - created_at: 创建时间 - updated_at: 更新时间。 **默认取值**：created_at。 | | offset | 否 | Integer | **参数解释**：偏移量，查询起始偏移，必须由数字组成。 **约束限制**：不涉及。 **取值范围**0-100000000。 **默认取值**：0。 | | limit | 否 | Integer | **参数解释**：限制量，单次查询总量，必须由数字组成。 **约束限制**：不涉及。 **取值范围**：1-1000。 **默认取值**：100。 | | workspace_id | 否 | String | **参数解释**：工作空间ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 **约束限制**：1-32字母，数字。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | asset_name | 否 | String | **参数解释**：资产名称,支持英文字母，数字，中划线，下划线，点，空格，中文汉字。 **约束限制**：1-128位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | asset_type | 否 | Array of strings | **参数解释**：资产类型。 **约束限制**：枚举值: - MODEL: 模型资产 - TEMPLATE: 模板资产 - DATASET: 数据集资产 - WORKFLOW: 工作流资产 - IMAGE: 镜像资产 - ALGORITHM：算法资产 - DATASET_TEMPLATE: 数据集模板资产 - DATA_OPERATOR：算子镜像资产 **默认取值**：不涉及。 | | asset_source | 否 | String | **参数解释**：资产来源。 **约束限制**：不涉及。 **取值范围**：枚举值: - Preset: 预置资产 - Publish: 用户发布资产 - Import: 用户导入资产 **默认取值**：不涉及。 | | asset_source_type | 否 | String | **参数解释**：用户资产来源。 **约束限制**：不涉及。 **取值范围**：preset_train：精调，custom_train：自定义训练，AgenticRL：强化学习。 **默认取值**：不涉及。 | | asset_code | 否 | String | **参数解释**：资产编码。 **约束限制**：1-60字母，数字，中划线，下划线，点。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | asset_version | 否 | String | **参数解释**：资产版本。 **约束限制**：数字或格式为x.y.z，x,y,z为数字。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | asset_group_id | 否 | String | **参数解释**：资产归属的资产组id，带有该字段将在同一个资产库中所有版本进行条件筛选，否则会筛选所有资产库中的主版本。 **约束限制**：1-36字母数字，下划线，中划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | filter_all_version | 否 | Boolean | **参数解释**：是否过滤所有版本。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | support_actions | 否 | Array of strings | **参数解释**：资产支持的操作列表，例如SFT：监督微调，LORA微调:LORA，在线部署：ONLINE-DEPLOY，强化学习：AgenticRL。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | tag | 否 | Array of strings | **参数解释**：检索资产时的标签，根据不同资产类型，条件可能不同。 - 需要匹配一个key对应一个value时格式为key=value - 需要匹配一个key对应多个value中的任意一个时格式为key=value1\|value2\|value3 - 需要匹配多个条件同时满足时key1=value1,key2=value2 - 如果需要实现模糊匹配格式为key1%=value2（右匹配）key2=%value2（左匹配） **约束限制**：不涉及。 | | is_mine | 否 | Boolean | **参数解释**：过滤我创建的资产，boolean类型，取值true：查询我创建的资产，取值false：查询所有资产。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | with_actions | 否 | Boolean | **参数解释**：列表查询是否包含action。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | asset_series | 否 | String | **参数解释**：资产品牌，例如DeepSeek,Qwen,Wan,GPT,Llama,GLM,ERNIE,Mistral,Kimi,Other。 **约束限制**：不涉及。 **取值范围**：0-40位。 **默认取值**：不涉及。 | | asset_capabilities | 否 | Array of strings | **参数解释**：资产能力，例如TextGeneration,ImageUnderstanding,ImageGeneration,VideoGeneration,AgenticRL,Other。 **约束限制**：0-40位。 | | asset_scenes | 否 | Array of strings | **参数解释**：资产场景，如DeepThinking。 **约束限制**：不涉及。 | | root_asset_id | 否 | String | **参数解释**：根资产id。 **约束限制**：1-36个字符，英文字母，数字，中划线，下划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | parent_asset_id | 否 | String | **参数解释**：父资产id。 **约束限制**：1-36个字符，英文字母，数字，中划线，下划线。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | is_deleted | 否 | Boolean | **参数解释**：是否返回软删除的资产。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：false。 | | asset_ids | 否 | Array of strings | **参数解释**：资产id。 **约束限制**：0-100个。 | | tag_mode | 否 | String | **参数解释**：tag组合方式 **约束限制**：不涉及。 **取值范围**：and：与，or：或。 **默认取值**：and。 | | dataset_usage | 否 | String | **参数解释**：数据集用途，GENERAL 通用数据集、 EVAL评测集。 **约束限制**：1-40位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | status | 否 | String | **参数解释**：资产状态。 **约束限制**：不涉及。 **取值范围**：枚举值: - online: 上线 - offline: 下线 - waiting: 等待中 **默认取值**：不涉及。 | | dataset_file_formats | 否 | Array of strings | **参数解释**：数据集存储格式，例如JSONL，TXT，MOBI，EPUB，DOCX，PDF。 **约束限制**：不涉及。 | | dataset_type | 否 | String | **参数解释**：数据集模态划分，如音频。 **约束限制**：1-40位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | dataset_sub_type | 否 | String | **参数解释**：数据集模态细分值，如语义分割。 **约束限制**：1-40位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | dataset_schema_format | 否 | String | **参数解释**：数据集逻辑规范，如盘古格式。 **约束限制**：1-40位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | creator | 否 | String | **参数解释**：资产创建者。 **约束限制**：1-128位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | data_source_id | 否 | String | **参数解释**：数据源的ID信息。 **约束限制**：1-40位字符。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，\[获取Token\]调用IAM的/v3/auth/tokens，在接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释**：符合条件的资产总数量。 **取值范围**：不涉及。 | | data | Array of [AssetDetail] objects | **参数解释**：树节点列表及关系 | 表5AssetDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_id | String | **参数解释**：资产id。 **取值范围**：不涉及。 | | parent_asset_id | String | **参数解释**：父资产id。 **取值范围**：不涉及。 | | root_asset_id | String | **参数解释**：根资产id。 **取值范围**：不涉及。 | | api_version | String | **参数解释**：资产API版本。 **取值范围**：v1,v2。 | | asset_name | String | **参数解释**：资产名称。 **取值范围**：不涉及。 | | asset_group_id | String | **参数解释**：需要加入的资产组id。 **取值范围**：0-36位字符，已存在的组id。 | | workspace_id | String | **参数解释**：工作空间ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 **取值范围**：1-32位字母，数字。 | | asset_type | String | **参数解释**：资产类型。 **取值范围**：枚举值： - TEMPLATE: 模板资产 - DATASET: 数据集资产 - WORKFLOW: 工作流资产 - IMAGE: 镜像资产 - ALGORITHM：算法资产 - MODEL: 模型资产 - DATASET_TEMPLATE: 数据集模板资产 | | sub_asset_type | String | **参数解释**：资产子类型。 **取值范围**：不涉及。 | | asset_desc | String | **参数解释**：资产描述。 **取值范围**：0-256位字符。 | | asset_code | String | **参数解释**：资产code。 **取值范围**：1-60字符，英文字母，数字，中划线，下划线，点。 | | asset_version | String | **参数解释**：资产版本。 **取值范围**：数字或格式为x.y.z，x,y,z为数字。 | | tags | map\ | **参数解释**：资产tag。 **取值范围**：不涉及。 | | support_actions | Array of strings | **参数解释**：资产支持的操作列表，例如监督微调:SFT,LORA微调:LORA,在线部署:ONLINE-DEPLOY,强化学习:AgenticRL。 | | asset_location | String | **参数解释**：资产文件存储地址。 **取值范围**：0-1024位字符。 | | actions | Array of [AssetActionRsp] objects | **参数解释**：资产可执行操作详情配置。 | | status | String | **参数解释**：资产状态。 **取值范围**：枚举值: - online: 上线 - offline: 下线 - waiting: 等待中 | | dataset_usage | String | **参数解释**：数据集用途。 **取值范围**：1-40位字符。 | | dataset_file_formats | Array of strings | **参数解释**：数据集存储格式，例如JSONL，TXT，MOBI，EPUB，DOCX，PDF。 | | dataset_type | String | **参数解释**：数据集模态划分，如音频。 **取值范围**：1-40位字符。 | | dataset_sub_type | String | **参数解释**：数据集模态细分值，如语义分割。 **取值范围**：1-40位字符。 | | dataset_schema_format | String | **参数解释**：数据集逻辑规范，如盘古格式。 **取值范围**：1-40位字符。 | | {自定义key} | map\ | | 表6AssetActionRsp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action_type | String | **参数解释**：资产action类型。 **取值范围**：不涉及。 | | action_dir | String | **参数解释**：资产action配置文件地址。 **取值范围**：不涉及。 | | {自定义key} | map\ | | #### 请求示例 ``` https://{endpoint}/v2/{project_id}/assets ``` #### 响应示例 **状态码：200** 资产列表 ``` { "total_count" : 100000000, "data" : [ { "asset_name" : "Pangu-AIKits-ImageSearch-Large-Tagging", "external_version" : "1.0.0", "asset_desc" : "Pangu-AI Kits-ImageSearch-Large-Tagging模型在MA Studio上首次支持。", "asset_version" : "0.1.7", "category" : "pangu", "storage_type" : "OBS", "asset_location" : "Pangu-AIKits-ImageSearch-Large-Tagging/0.1.7/models", "asset_type" : "ImageSearch", "sub_asset_type" : "", "asset_code" : "Pangu-AIKits-ImageSearch-Large-Tagging", "asset_source" : "Preset", "asset_tag" : "PRETRAIN，SFT", "security_policy" : "SCCBase64", "encode_type" : "BASE64", "asset_series" : "AIKits", "asset_scenes" : [ "ImageSearch" ] }, { "asset_name" : "Pangu-AIKits-ImageSearch-Large-Tagging", "asset_version" : "0.1.7", "category" : "pangu", "storage_type" : "OBS", "asset_location" : "Pangu-AIKits-ImageSearch-Large-Tagging/0.1.7/models", "asset_type" : "ImageSearch", "sub_asset_type" : "", "asset_code" : "Pangu-AIKits-ImageSearch-Large-Tagging", "asset_source" : "Preset", "asset_tag" : "PRETRAIN，SFT", "security_policy" : "SCCBase64", "encode_type" : "BASE64", "asset_series" : "AIKits", "asset_readme" : "/readme/model.md", "asset_group_readme" : "/readme/model_group.md", "asset_scenes" : [ "ImageSearch" ] }, { "asset_name" : "Pangu-AIKits-ImageSearch-Large-Tagging", "asset_name_en" : "Pangu-AIKits-ImageSearch-Large-Tagging", "asset_desc" : "Pangu-AI Kits-ImageSearch-Large-Tagging模型在MA Studio上首次支持。", "asset_version" : "0.1.7", "category" : "pangu", "storage_type" : "OBS", "asset_location" : "Pangu-AIKits-ImageSearch-Large-Tagging/0.1.7/models", "asset_type" : "ImageSearch", "sub_asset_type" : "", "asset_code" : "Pangu-AIKits-ImageSearch-Large-Tagging", "asset_source" : "Preset", "asset_tag" : "PRETRAIN，SFT", "security_policy" : "SCCBase64", "encode_type" : "BASE64", "asset_series" : "AIKits", "asset_scenes" : [ "ImageSearch" ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 资产列表 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。