# 查询算法列表 - ListAlgorithms #### 功能介绍 查询算法列表接口用于获取ModelArts平台上所有算法的列表。 该接口适用于以下场景：当用户需要查看平台上的所有可用算法时，可以通过此接口获取算法列表。使用该接口的前提条件是用户具有查看算法列表的权限。查询操作完成后，平台将返回包含算法名称、ID等信息的列表。若用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListAlgorithms)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:aiAlgorithm:list | List | - | - | - | - | #### URI GET /v2/{project_id}/algorithms 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**：分页列表的起始页。 **约束限制**：最小为0。例如设置为0，则表示从第一页开始查询。 **取值范围**：不涉及。 **默认取值**：默认为0。 | | limit | 否 | Integer | **参数解释**：查询算法的每页条目数。 **约束限制**：最小为1，最大为50。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | sort_by | 否 | String | **参数解释**：查询算法排列顺序的指标。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：默认使用create_time排序。 | | order | 否 | String | **参数解释**：查询算法排列顺序。 **约束限制**：不涉及。 **取值范围**： - asc：升序 - desc：降序 **默认取值**：默认为"desc"。 | | searches | 否 | String | **参数解释**：查询算法所要过滤的条件，如算法名称模糊匹配：searches=name:algorithm-。 **约束限制**：支持多条件查询格式：searches=key1:value1,key2:value2。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | workspace_id | 否 | String | **参数解释**：工作空间ID。 **约束限制** ：获取方法请参见[查询工作空间列表](https://support.huaweicloud.com/api-modelarts/ListWorkspace.html#ZH-CN_TOPIC_0000002723741766)。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**：查询到当前用户名下的所有算法总数。 **取值范围**：不涉及。 | | count | Integer | **参数解释**：查询到当前用户名下的所有符合查询条件的算法总数。 **取值范围**：不涉及。 | | limit | Integer | **参数解释**：查询到当前用户名下的所有算法限制个数。 **取值范围**：最小为1，最大为50。 | | offset | Integer | **参数解释**：查询作业的页数，最小为0。例如设置为0，则表示从第一页开始查询。 **取值范围**：不涉及。 | | sort_by | String | **参数解释**：查询到当前用户名下的所有算法排序依赖字段。 **取值范围**：不涉及。 | | order | String | **参数解释**：查询到当前用户名下的所有算法排序方式。 **取值范围**： - asc：升序 - desc：降序 | | group_by | String | **参数解释**：查询到当前用户名下的所有算法分组方式。 **取值范围**：不涉及。 | | items | Array of [AlgorithmResponse] objects | **参数解释**：查询到当前用户名下的所有符合查询条件的算法详情。 | 表4AlgorithmResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metadata | [metadata] object | **参数解释**：算法的元数据，描述算法基本信息。 | | job_config | [job_config] object | **参数解释**：算法配置信息，如启动文件等。 | | resource_requirements | Array of [resource_requirements] objects | **参数解释**：算法资源约束，可不设置。设置后，在算法使用于训练作业时，控制台会过滤可用的公共资源池。 | | advanced_config | [advanced_config] object | **参数解释**：算法高级策略：标识算法是否/如何支持三类高级训练特性：弹性训练、共享 GPU 训练、自动超参搜索。 | 表5metadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：算法id，创建算法时无需填写。 **取值范围**：不涉及。 | | name | String | **参数解释**：算法名称。 **取值范围**：限制为1-64位只含数字、字母、下划线和中划线的名称。 | | description | String | **参数解释**：对算法的描述。 **取值范围**：字符串的长度限制为\[0, 256\]。 | | workspace_id | String | **参数解释**：指定算法所处的工作空间。"0" 表示默认的工作空间。 **取值范围**：不涉及。 | | ai_project | String | **参数解释**：指定算法所属的ai项目。ai项目已下线，无需关注。 **取值范围**：不涉及。 | | user_name | String | **参数解释**：用户名称。 **取值范围**：不涉及。 | | domain_id | String | **参数解释**：用户的domainID。 **取值范围**：不涉及。 | | source | String | **参数解释**：算法来源类型。 **取值范围**：不涉及。 | | api_version | String | **参数解释**：算法api版本，标识新旧版。 **取值范围**：不涉及。 | | is_valid | Boolean | **参数解释**：算法可用性。 **取值范围**： - true：可用 - false：不可用 | | state | String | **参数解释**：算法状态。 **取值范围**：不涉及。 | | tags | Array of Map\ objects | **参数解释**：算法标签，以key/value键值对形式表示，key为标签名称，value为标签值。 | | attr_list | Array of strings | **参数解释**：算法属性列表。 | | version_num | Integer | **参数解释**：算法版本数量。 **取值范围**：不涉及。 | | size | Integer | **参数解释**：算法大小，单位是字节。 **取值范围**：不涉及。 | | create_time | Long | **参数解释**：算法创建时间戳，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | update_time | Long | **参数解释**：算法更新时间戳，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | 表6job_config | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code_dir | String | **参数解释**：算法的代码目录。如：/usr/app/。 **取值范围**：不涉及。 | | boot_file | String | **参数解释**：算法的代码启动文件，需要在代码目录下。如：/usr/app/boot.py。 **取值范围**：不涉及。 | | command | String | **参数解释**：自定义镜像算法的容器启动命令。 **取值范围**：不涉及。 | | parameters | Array of [ParameterResp] objects | **参数解释**：算法的运行参数。 | | inputs | Array of [inputs] objects | **参数解释**：算法的数据输入。 | | outputs | Array of [outputs] objects | **参数解释**：算法的数据输出。 | | engine | [engine] object | **参数解释**：算法的引擎。 | | code_tree | [CodeTreeNode] object | **参数解释**：算法的目录结构树。 | | parameters_customization | Boolean | **参数解释**：算法是否允许创建训练作业时自定义超参。 **取值范围**： - true：允许 - false：不允许 | 表7ParameterResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：参数名称。 **取值范围**：不涉及。 | | value | String | **参数解释**：参数值。 **取值范围**：不涉及。 | | description | String | **参数解释**：参数描述信息。 **取值范围**：不涉及。 | | constraint | [constraint] object | **参数解释**：参数属性。 | | i18n_description | [i18n_description] object | **参数解释**：国际化描述。 | 表8constraint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**：参数种类。 **取值范围**：枚举值如下： - Integer：整数 - Float：浮点数 - String：字符串 - Boolean：布尔值 | | editable | Boolean | **参数解释**：是否可编辑。 **取值范围**： - true：可编辑 - false：不可编辑 | | required | Boolean | **参数解释**：是否必须。 **取值范围**： - true：必须 - false：非必须 | | sensitive | Boolean | **参数解释**：是否敏感。该功能暂未实现。 **取值范围**： - true：敏感 - false：不敏感 | | valid_type | String | **参数解释**：有效种类。 **取值范围**：枚举值如下： - Choice：枚举值 - Range：范围值 - None：无 | | valid_range | Array of strings | **参数解释**：有效范围。 | 表9i18n_description | 参数 | 参数类型 | 描述 | |:---|:---|:---| | language | String | **参数解释**：国际语种。 **取值范围**：。可选值如下： - zh-cn（中文） - en-us（英文） | | description | String | **参数解释**：国际化语种的描述信息。 **取值范围**：不涉及。 | 表10inputs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：数据输入通道名称。 **取值范围**：不涉及。 | | description | String | **参数解释**：数据输入通道描述信息。 **取值范围**：不涉及。 | | remote_constraints | Array of [remote_constraints] objects | **参数解释**：数据输入约束。 | 表11remote_constraints | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_type | String | **参数解释**：数据输入类型，包括数据存储位置、数据集两种方式，如obs：数据存储位置（OBS） modelarts_dataset：ModelArts数据集，其中数据集功能即将下线。 **取值范围**：不涉及。 | | attributes | Array of Map\ objects | **参数解释**：数据输入为数据集时的相关属性。枚举值： - data_format数据格式 - data_segmentation数据切分方式 - dataset_type标注类型 | 表12outputs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：数据输出通道名称。 **取值范围**：不涉及。 | | description | String | **参数解释**：数据输出通道描述信息。 **取值范围**：不涉及。 | 表13engine | 参数 | 参数类型 | 描述 | |:---|:---|:---| | engine_id | String | **参数解释**：算法选择的引擎规格ID。 **取值范围**：不涉及。 | | engine_name | String | **参数解释**：算法选择的引擎名称。 **取值范围**：不涉及。 | | engine_version | String | **参数解释**：算法选择的引擎版本名称。 **取值范围**：不涉及。 | | image_url | String | **参数解释**：算法选择的自定义镜像地址。 **取值范围**：不涉及。 | 表14CodeTreeNode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：算法目录树当前层级目录名。 **取值范围**：不涉及。 | | children | Array of [CodeTreeNode] objects | **参数解释**：算法目录树当前层级目录下子文件和子目录。 | 表15resource_requirements | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：资源约束。 **取值范围**：可选值如下： - 资源类型（flavor_type），对应值可选择CPU、GPU或Ascend - 是否支持多卡训练（device_distributed_mode），对应值可选择支持（multiple）、不支持（singular） - 是否支持分布式训练（host_distributed_mode），对应值可选择支持（multiple）、不支持（singular） | | value | Array of strings | **参数解释**：资源约束键对应值。 | | operator | String | **参数解释**：键与值关系。 **取值范围**：in（键与值的包含关系），例如flavor_type in \[CPU,GPU\]。 | 表16advanced_config | 参数 | 参数类型 | 描述 | |:---|:---|:---| | auto_search | [auto_search] object | **参数解释**：超参搜索策略。 | 表17auto_search | 参数 | 参数类型 | 描述 | |:---|:---|:---| | skip_search_params | String | **参数解释**：需要排除的超参组合。 **取值范围**：不涉及。 | | reward_attrs | Array of [reward_attrs] objects | **参数解释**：搜索指标列表。 | | search_params | Array of [search_params] objects | **参数解释**：搜索参数。 | | algo_configs | Array of [algo_configs] objects | **参数解释**：搜索算法配置。 | 表18reward_attrs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：指标名称。 **取值范围**：不涉及。 | | mode | String | **参数解释**：搜索方向。 **取值范围**： - max：表示指标值越大越好 - min：表示指标值越小越好 | | regex | String | **参数解释**：指标正则表达式。 **取值范围**：不涉及。 | 表19search_params | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：超参名称。 **取值范围**：不涉及。 | | param_type | String | **参数解释**：参数类型。 **取值范围**： - continuous：指定时表示这个超参是连续类型的。连续类型的超参在算法使用于训练作业时，控制台显示为输入框 - discrete：指定时表示这个超参是离散类型的。离散类型的超参在算法使用于训练作业时，控制台显示为下拉选择框架 | | lower_bound | String | **参数解释**：超参下界。 **取值范围**：不涉及。 | | upper_bound | String | **参数解释**：超参上界。 **取值范围**：不涉及。 | | discrete_points_num | String | **参数解释**：连续型超参离散化取值个数。 **取值范围**：不涉及。 | | discrete_values | String | **参数解释**：离散型超参的取值列表。 **取值范围**：不涉及。 | 表20algo_configs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：搜索算法名称。 **取值范围**：不涉及。 | | params | Array of [AutoSearchAlgoConfigParameterResp] objects | **参数解释**：搜索算法参数。 | 表21AutoSearchAlgoConfigParameterResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：参数键。 **取值范围**：不涉及。 | | value | String | **参数解释**：参数值。 **取值范围**：不涉及。 | | type | String | **参数解释**：参数种类。 **取值范围**：枚举值如下： - Integer：整数类型。 - Float：浮点数类型。 - String：字符串类型。 | #### 请求示例 如下以查询算法限制个数为1，查询作业名字中包含TestModelArtsalgorithm的所有算法数据为例。 ``` GET https://endpoint/v2/{project_id}/algorithms?limit=1&searches=name%3ATestModelArtsalgorithm ``` #### 响应示例 **状态码：200** ``` { "total" : 1, "count" : 1, "limit" : 1, "offset" : 0, "sort_by" : "create_time", "order" : "desc", "group_by" : "", "items" : [ { "metadata" : { "id" : "2e5451fe-913f-4492-821a-2981031382f7", "name" : "TestModelArtsalgorithm", "description" : "This is a ModelArts algorithm", "create_time" : 1636600721742, "workspace_id" : "0", "ai_project" : "default-ai-project", "user_name" : "", "domain_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxx", "source" : "custom", "api_version" : "", "is_valid" : true, "state" : "", "size" : 4791, "tags" : null, "attr_list" : null, "version_num" : 0, "update_time" : 0 }, "job_config" : { "code_dir" : "/algo-test/pytorch/work1/code/", "boot_file" : "/algo-test/pytorch/work1/code/test-pytorch.py", "command" : "", "parameters" : [ { "name" : "test-parameter", "description" : "", "i18n_description" : null, "value" : "10", "constraint" : { "type" : "String", "editable" : true, "required" : false, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } } ], "parameters_customization" : true, "inputs" : [ { "name" : "data_url", "description" : "name to translate" } ], "outputs" : [ { "name" : "train_url", "description" : "name to translate" } ], "engine" : { "engine_id" : "pytorch-cp36-1.3.0", "engine_name" : "PyTorch", "engine_version" : "PyTorch-1.3.0-python3.6" }, "code_tree" : { "name" : "code/", "children" : [ { "name" : "test-pytorch.py" } ] } }, "resource_requirements" : null, "advanced_config" : { } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。