Obtaining Software Information

Function

This API is used to query information about supported software. You can use flavor_type and name to filter software information. It is used when you need to know the software supported by the system and its details, for example, when you need to select a proper software version or configuration environment. Before using this API, ensure that you have the permission to view software information. After the query, the API returns the software list that meets the search criteria, including the software name, version, and type. If you do not have the required permission, the query parameters are incorrect, or no software that meets the search criteria exists in the system, the API returns an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/dev-servers/software

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
flavor_type	No	String	Definition: Lite Server specification type. Constraints: The value can contain letters, digits, and hyphens (-). Range: N/A Default Value: N/A
type	No	String	Definition: Lite Server software type. Constraints: The value can contain letters, digits, and hyphens (-). Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
data	Array of SoftwareData objects	All flavor types and supported software.

**Table 4** SoftwareData
Parameter	Type	Description
flavor_type	String	Definition: Flavor type. Range: ascend_snt9b, ascend_snt9b23, and ascend_generic.
support	Array of SoftwareSupport objects	Information about all software supported by flavor_type.

**Table 5** SoftwareSupport
Parameter	Type	Description
type	String	Definition: Software name. Range: ASCEND_HDK, CES_AGENT, ASCEND_CANN, and K8S_TOOLKITS.
info	Array of VersionInfo objects	Software version information, including the software version number and software description.

**Table 6** VersionInfo
Parameter	Type	Description
id	String	Definition: ID. Range: N/A.
version	String	Version.
description	String	Version description, which is displayed in the drop-down list on the frontend.
url	String	Download link.
status	String	Definition: Availability status. Range: ACTIVE and INACTIVE
file	Array of File objects	Software package list.

**Table 7** File
Parameter	Type	Description
name	String	Software package name.
file	String	Software package and installation package.

Example Requests

GET https://{endpoint}/v1/{project_id}/dev-servers/software

{ }

Example Responses

Status code: 200

{
  "data" : [ {
    "flavor_type" : "ASCEND_SNT9B",
    "support" : [ {
      "info" : [ {
        "description" : "Driver: 23.0.6 | Firmware: 7.1.0.9.220",
        "id" : "5a0f7b07-b4d7-4f7c-8290-617f3e4be8d0",
        "status" : "ACTIVE",
        "url" : "https://abc.com/hdk",
        "version" : "23.0.6"
      }, {
        "description" : "Driver: 24.1.0.3 | Firmware: 7.5.0.3.220",
        "id" : "af890aa4-4579-418a-83ca-d6e41398ca65",
        "status" : "ACTIVE",
        "url" : "https://abc.com/hdk",
        "version" : "24.1.0.3"
      } ],
      "type" : "ASCEND_HDK"
    } ]
  } ]
}