Updated on 2025-09-30 GMT+08:00

Querying the Image File List

Function

This API is used to query the image file list. For a CI/CD image, only the image_id parameter needs to be specified. The organization name, image name, and image tag are not required. For other image types, the organization name, image name, and image tag are mandatory.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/{image_id}/files

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

image_id

Yes

String

Image ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that the server belongs to.

An enterprise project can be configured only after the enterprise project function is enabled.

The default value of an enterprise project ID is 0, indicating the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you only have the permissions for a specific enterprise project, to query a server in the project, specify the enterprise project ID. Otherwise, an error will be reported due to insufficient permission.

image_type

Yes

String

Image type. Its value can be:

  • private_image: private image repository

  • shared_image: shared image repository

  • instance_image: enterprise image

  • **cicd **: CI/CD image

  • harbor: Harbor repository image

namespace

No

String

Organization name.

image_name

No

String

Image name.

tag_name

No

String

Image tag name

file_name

No

String

Filter and query file names (fuzzy match is supported).

limit

No

Integer

Number of returned records. Default value: 10

offset

No

Integer

Start index. Default value: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

region

Yes

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

data_list

Array of ImageFileInfo objects

List

Table 5 ImageFileInfo

Parameter

Type

Description

file_name

String

File name

file_path

String

Directory

size

Integer

File size

Example Requests

  • Query the private image file list.

    GET https://{endpoint}/v5/{project_id}/image/image_id}/files?limit=10&offset=0&namespace=scc_hss_container&image_name=proxy-agent&tag_name=24.5.0-x86_64&image_id=sha256:0b08c2b4162c7007fba407806554a0b4f56bfcfa6b93c2644ebd2d1decd7ee53&image_type=private_image&enterprise_project_id=all_granted_eps
  • Query the file list of the CI/CD image whose image_id is 111.

    GET https://{endpoint}/v5/{project_id}/image/111/files?limit=10&offset=0&type=linux_vul&image_type=cicd&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 50,
  "data_list" : [ {
    "size" : 5354296,
    "file_name" : "ld.gold",
    "file_path" : "/usr/bin/"
  }, {
    "size" : 3178200,
    "file_name" : "dwp",
    "file_path" : "/usr/bin/"
  }, {
    "size" : 2513000,
    "file_name" : "libcrypto.so.1.0.2k",
    "file_path" : "/usr/lib64/"
  }, {
    "size" : 2151672,
    "file_name" : "libc-2.17.so",
    "file_path" : "/usr/lib64/"
  }, {
    "size" : 1850464,
    "file_name" : "libdb-5.3.so",
    "file_path" : "/usr/lib64/"
  }, {
    "size" : 1847496,
    "file_name" : "libpython2.7.so.1.0",
    "file_path" : "/usr/lib64/"
  }, {
    "size" : 1722848,
    "file_name" : "libgio-2.0.so.0.5600.1",
    "file_path" : "/usr/lib64/"
  }, {
    "size" : 1686744,
    "file_name" : "libopcodes-2.27-34.base.el7.so",
    "file_path" : "/usr/lib64/"
  }, {
    "size" : 1620416,
    "file_name" : "systemd",
    "file_path" : "/usr/lib/systemd/"
  }, {
    "size" : 1550080,
    "file_name" : "systemd-analyze",
    "file_path" : "/usr/bin/"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListImageFilesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListImageFilesRequest request = new ListImageFilesRequest();
        request.withImageId("{image_id}");
        try {
            ListImageFilesResponse response = client.listImageFiles(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListImageFilesRequest()
        request.image_id = "{image_id}"
        response = client.list_image_files(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListImageFilesRequest{}
	request.ImageId = "{image_id}"
	response, err := client.ListImageFiles(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.