列举软件-ListSoftware

功能介绍

列举软件接口提供用户根据超节点类型族、软件类型和软件状态过滤获取软件信息的能力。适用于以下场景：用户需要升级昇腾软件配套时，可以根据自己的超节点类型族来获取可升级的软件版本信息。

调试

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

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
aics::listSoftware	List	-	-	-	-

URI

GET /v2/{project_id}/software

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID，获取方法请参见获取项目ID。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释: 分页查询单页记录数量。约束限制: 不涉及。取值范围: 1~100。默认取值: 20。
marker	否	String	参数解释: 分页标记，本次请求获取该标记后的资源，base64编码。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。
software_type	否	String	参数解释: 按软件类型规格筛选软件。约束限制: 不涉及。取值范围: ASCEND_HDK：昇腾HDK。默认取值: 不涉及。
family	否	String	参数解释: 按规格族过滤软件，用户可以通过查询超节点类型详情来获取。约束限制: 不涉及。取值范围: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。默认取值: 不涉及。
status	否	String	参数解释: 软件状态。约束限制: 不涉及。取值范围: ACTIVE：可用。 INACTIVE：不可用。默认取值: 不涉及。
version	否	String	参数解释: 按软件版本号过滤。约束限制: 不涉及。取值范围: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。默认取值: 不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数解释: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
page_info	PageInfo object	参数解释: 分页信息。取值范围: 不涉及。
software	Array of Software objects	参数解释: 软件列表。取值范围: 不涉及。

表5 PageInfo
参数	参数类型	描述
next_marker	String	参数解释: 以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。取值范围: 不涉及。
current_count	Integer	参数解释 : 当前查询结果数量。取值范围 : 不涉及。

表6 Software
参数	参数类型	描述
version	String	参数解释: 软件版本号。取值范围: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。
family	String	参数解释: 按芯片类型过滤软件。取值范围: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。
software_type	String	参数解释: 按软件类型规格筛选软件。取值范围: ASCEND_HDK：昇腾HDK。
description	String	参数解释: 软件版本描述信息。取值范围: 长度1-256。
status	String	参数解释: 软件状态。取值范围: ACTIVE：可用。 INACTIVE：不可用。
files	Array of SoftwareFile objects	参数解释: 软件包列表。取值范围: 软件包数量最多10个。

表7 SoftwareFile
参数	参数类型	描述
name	String	参数解释: 软件中的文件名。取值范围: 只能由英文字母、数字及“_”、“-”、“.”组成，且长度为1-128。
type	String	参数解释: 软件中的文件类型，如HDK包括的类型有driver/firmware/mcu。取值范围: 只能由英文字母、数字及“_”、“-”、“.”组成，且长度为1-64。

请求示例

列举软件请求示例。使用场景：用户需要升级昇腾软件配套时，根据自己的超节点类型族获取可升级的软件版本信息。

GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/software

响应示例

状态码：200

成功查询软件列表。

{
  "page_info" : {
    "next_marker" : "NTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAx",
    "current_count" : 1
  },
  "software" : [ {
    "version" : "24.1.0",
    "software_type" : "ASCEND_HDK",
    "status" : "ACTIVE",
    "family" : "hypernode-family-1",
    "description" : "昇腾HDK 24.1.0版本",
    "files" : [ {
      "name" : "ascend-hdk-24.1.0-driver.run",
      "type" : "driver"
    }, {
      "name" : "ascend-hdk-24.1.0-firmware.run",
      "type" : "firmware"
    } ]
  } ]
}

状态码

状态码	描述
200	成功查询软件列表。

错误码

请参见错误码。

父主题： 软件管理

上一篇：软件管理

下一篇：节点