通过asset code 和asset version查询资产详情 - ShowAssetByCodeAndVersion

功能介绍

通过资产编码和版本查询资产详情接口用于在ModelArts平台上根据asset_code和版本asset_version查询指定资产的详细信息。

该接口适用于以下场景：当用户已知资产编码和版本但无资产ID时，可以通过此接口获取资产的完整详情及可执行操作。使用该接口的前提条件是用户已具备项目访问权限，并已知目标资产的编码和版本号。平台将根据资产编码和版本查询并返回资产的详情信息。若资产不存在或用户无权限操作，接口将返回相应的错误信息。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/assets/{asset_code}/{asset_version}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：华为云项目ID，[获取项目ID]在ModelArts Studio任意页面，按F12进入开发者工具，刷新页面，在开发者工具Network页签找到/rest/me接口，从此接口的response里找到project_id字段。约束限制：1-64字符，英文字母，数字，下划线，中划线。取值范围：不涉及。默认取值：不涉及。
asset_code	是	String	参数解释：资产code。约束限制：1-60字符，英文字母，数字，中划线，下划线，点。取值范围：不涉及。默认取值：不涉及。
asset_version	是	String	参数解释：资产version。约束限制：数字或为格式x.y.z， x,y,z均为数字。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
workspace_id	否	String	参数解释：工作空间ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。约束限制：1-32字母，数字。取值范围：不涉及。默认取值：不涉及。
asset_type	否	String	资产类型

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token]调用IAM的/v3/auth/tokens，在接口响应消息头中X-Subject-Token的值即为Token。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
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<string, object>	参数解释：资产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<string, *>

表5 AssetActionRsp
参数	参数类型	描述
action_type	String	参数解释：资产action类型。取值范围：不涉及。
action_dir	String	参数解释：资产action配置文件地址。取值范围：不涉及。
{自定义key}	map<string, *>

请求示例

https://{endpoint}/v2/{project_id}/assets/{asset_code}/{asset_version}

响应示例

状态码：200

资产详情

{
  "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" ]
}

状态码

状态码	描述
200	资产详情

错误码

请参见错误码。

父主题： 资产中心API

上一篇：查询README中的yaml内容 - ShowAssetExtendMessage

下一篇：授权管理