文档首页/ AI开发平台ModelArts/ API参考/ 训练管理/ 获取自动化搜索作业yaml模板的信息 - ShowAutoSearchYamlTemplatesInfo
更新时间:2025-11-27 GMT+08:00
分享

获取自动化搜索作业yaml模板的信息 - ShowAutoSearchYamlTemplatesInfo

功能介绍

获取自动化搜索作业yaml模板的信息接口用于获取自动化搜索作业的yaml配置模板详情。

该接口适用于以下场景:当用户需要创建或修改自动化搜索作业时,可以通过此接口获取yaml模板的详细信息,以便了解和配置作业的各项参数。使用该接口的前提条件是用户具有查看自动化搜索作业模板的权限。接口响应消息体中包含yaml模板的详细信息。若用户无权限操作,接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。获取该接口关联的CLI示例: hcloud ModelArts ShowAutoSearchYamlTemplatesInfo

授权信息

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

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

URI

GET /v2/{project_id}/training-jobs/autosearch/yaml-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。获取方法请参见获取项目ID和名称

约束限制:1 - 64字符,字母、数字和中划线。

取值范围:不涉及。

默认取值:不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

yaml_templates

Array of YamlTemplate objects

参数解释:所有yaml文件的目录和文件名信息。

表3 YamlTemplate

参数

参数类型

描述

algorithm_type_en

String

参数解释:AutoSearch算法类型,英文描述。

取值范围:不涉及。

algorithm_type_zh

String

参数解释:AutoSearch算法类型,中文描述。

取值范围:不涉及。

algorithm_names

Array of strings

参数解释:该算法类型下所有算法的名称。

请求示例

查询自动化搜索作业支持的yaml配置模板的信息

GET https://endpoint/v2/{project_id}/training-jobs/autosearch/yaml-templates

响应示例

状态码:200

ok

{
  "yaml_templates" : [ {
    "algorithm_type_en" : "hpo",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "Anneal", "Bayes", "DragonFly", "FixNorm", "GridSearch", "TPE" ]
  }, {
    "algorithm_type_en" : "nas",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "AutoBSS", "AutoEvo", "AutoTopo", "MBNAS" ]
  }, {
    "algorithm_type_en" : "augment",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "AdvAutoAugment", "AutoAugment" ]
  }, {
    "algorithm_type_en" : "compression",
    "algorithm_type_zh" : "algorithm_type_zh to translate",
    "algorithm_names" : [ "AutoCompress" ]
  } ]
}

状态码

状态码

描述

200

ok

错误码

请参见错误码

相关文档