查询README中的yaml内容 - ShowAssetExtendMessage
功能介绍
查询资产扩展信息接口用于在ModelArts平台上获取指定资产README文件中的YAML内容。
该接口适用于以下场景:当用户需要查看预置资产的扩展元数据信息时,可以通过此接口解析README中的YAML片段并返回。使用该接口的前提条件是用户已具备项目访问权限,并已知目标资产ID。平台将根据资产ID读取对应README文件,解析其中的YAML内容后以JSON格式返回。若资产不存在、资产非预置资产、README文件未找到或用户无权限操作,接口将返回相应的错误信息或空数据。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/assets/{asset_id}/extend-message
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:华为云项目ID,[获取项目ID]在ModelArts Studio任意页面,按F12进入开发者工具,刷新页面,在开发者工具Network页签找到/rest/me接口,从此接口的response里找到project_id字段。 约束限制:1-64字符,英文字母,数字,下划线,中划线。 取值范围:不涉及。 默认取值:不涉及。 |
| asset_id | 是 | String | 参数解释:资产id。 约束限制:1-36字符,英文字母,数字,下划线,中划线。 取值范围:不涉及。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释:工作空间ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 约束限制:1-32字母,数字。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,[获取Token]调用IAM的/v3/auth/tokens,在接口响应消息头中X-Subject-Token的值即为Token。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| {自定义key} | Map<String,Object> | 资产在README中的扩展内容。 |
请求示例
https://{endpoint}/v2/{project_id}/assets/{asset_id}/extend-message 响应示例
状态码:200
README中的yaml内容
{
"basic_info" : [ {
"title" : "模型类型",
"key" : "model_type",
"value" : "图像理解"
}, {
"title" : "支持语种",
"key" : "support_language",
"value" : "30+语言"
}, {
"title" : "输入类型",
"key" : "input_type",
"value" : "文本+图像"
}, {
"title" : "输出类型",
"key" : "output_type",
"value" : "文本"
}, {
"title" : "参数大小",
"key" : "parameter_size",
"value" : "30B"
}, {
"title" : "上下文长度",
"key" : "context_size",
"value" : "32K"
} ],
"model_capability" : [ {
"title" : "非思考",
"value" : "支持"
}, {
"title" : "前缀缓存",
"value" : "支持"
} ],
"infer_feature" : [ {
"card_specification" : "Snt9b1/Snt9b2/Snt9b3",
"features" : [ {
"title" : "推理精度",
"value" : "INT8",
"icon" : "asset-detail/modeldeploy-fp16.svg",
"group_name" : "推理精度",
"group" : "inference_precision"
}, {
"value" : "Ascend-vLLM",
"group_name" : "推理框架",
"group" : "inference_framework"
}, {
"value" : "Snt9b1/Snt9b2/Snt9b3",
"group_name" : "卡类型",
"group" : "card_type"
}, {
"value" : 2,
"group_name" : "起推卡数",
"group" : "card_num"
} ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | README中的yaml内容 |
错误码
请参见错误码。