Help Center/ Image Management Service/ API Reference/ IMS APIs/ Image/ Querying Supported Image OSs
Updated on 2026-07-07 GMT+08:00
View PDF
Share

Querying Supported Image OSs

Function

This API is used to query compatible ECS OSs in the current region.

Huawei Cloud has stopped providing Windows images. This API will no longer be used to query OSs compatible with Windows images.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. For details about the required permissions, see Permissions and Supported Actions.

URI

GET /v1/cloudimages/os_version

Table 1 Parameter description

Parameter

Mandatory

Type

Description

tag

No

String

Definition

OS tag. You can query OSs with specified features based on the tag value.

Constraints

If this parameter is not specified, all the supported OSs in the current region will be returned.

Range

  • bms: indicates the BMS OS versions supported by the image.
  • uefi: indicates the OS versions that support the UEFI boot mode.

Default Value

N/A

Request

  • Request parameters

    None

Example Request

  • Querying supported OSs 
    GET https://{Endpoint}/v1/cloudimages/os_version
  • Querying supported OSs by filters 
    GET https://{Endpoint}/v1/cloudimages/os_version?tag=kvm&tag=uefi

Response

  • Response parameters

    Parameter

    Type

    Description

    [Array]

    Array of objects

    Definition

    OSs supported by images. For details, see Table 2.

    Range

    N/A
    Table 2 Data structure description of the [Array] field

    Parameter

    Type

    Description

    platform

    String

    Definition

    OS platform.

    Range

    N/A

    version_list

    Array of objects

    Definition

    OS details. For details, see Table 3.

    Range

    N/A
    Table 3 Data structure description of the [Array].version_list field

    Parameter

    Type

    Description

    platform

    String

    Definition

    OS platform.

    Range

    N/A

    os_version_key

    String

    Definition

    OS key value.

    Range

    The default key value is the value of os_version. os_version indicates the complete OS version.

    os_version

    String

    Definition

    Complete OS version.

    Range

    N/A

    os_bit

    Integer

    Definition

    OS bitness.

    Range

    Generally, the value is 32 or 64.

    os_type

    String

    Definition

    OS type.

    Range

    • Linux
    • Windows
  • Example response 
    STATUS CODE 200
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
    		 
    [
    {
        "platform": "SUSE",
        "version_list": [
            {
                "platform": "SUSE",
                "os_version_key": "SUSE Linux Enterprise Server 15 64bit",
                "os_version": "SUSE Linux Enterprise Server 15 64bit",
                "os_bit": 64,
                "os_type": "Linux"
            },
            {
                "platform": "SUSE",
                "os_version_key": "SUSE Linux Enterprise Server 12 SP3 64bit",
                "os_version": "SUSE Linux Enterprise Server 12 SP3 64bit",
                "os_bit": 64,
                "os_type": "Linux"
            }
        ]
    },
    {
        "platform": "Other",
        "version_list": [
            {
                "platform": "Other",
                "os_version_key": "Other(32 bit)",
                "os_version": "Other(32 bit)",
                "os_bit": 32,
                "os_type": "Linux"
            }
        ]
    }
]

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    Request error. For details about the returned error code, see Error Codes.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    You do not have the rights to perform the operation.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    The service is unavailable.
Parent topic: Image