Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Query the Image Software List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Query the Image Software List

Function

This API is used to query the image software 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.

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 /v5/{project_id}/image/{image_id}/apps

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

image_id

Yes

String

Definition

Image ID.

Constraints

N/A

Range

Length: 0 to 65535 characters

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

image_type

Yes

String

Definition

Image type.

Constraints

N/A

Range

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

Default Value

N/A

namespace

No

String

Definition

Organization name.

Constraints

N/A

Range

Length: 0 to 65535 characters

Default Value

N/A

image_name

No

String

Definition

Image name.

Constraints

N/A

Range

Length: 0 to 65535 characters

Default Value

N/A

tag_name

No

String

Definition

Image tag name

Constraints

N/A

Range

Length: 0 to 65535 characters

Default Value

N/A

app_name

No

String

Definition

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

Constraints

N/A

Range

Length: 0 to 65535 characters

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number.

Range

Minimum value: 0; maximum value: 2147483647

data_list

Array of ImageAppsInfo objects

List
Table 5 ImageAppsInfo

Parameter

Type

Description

app_name

String

Definition

Software name.

Range

Length: 0 to 64 characters

app_type

String

Definition

Software type.

Range

Length: 0 to 64 characters

app_version

String

Definition

Software version.

Range

Length: 0 to 128 characters

vul_num

Integer

Definition

Number of software vulnerabilities

Range

Minimum value: 0; maximum value: 2147483647

Example Requests

  • Query the image file list in the image repository.

    GET https://{endpoint}/v5/{project_id}/image/sha256:0b08c2b4162c7007fba407806554a0b4f56bfcfa6b93c2644ebd2d1decd7ee53/apps?limit=10&offset=0&namespace=scc_hss_container&tag_name=24.5.0-x86_64&image_name=proxy-agent&image_id=sha256:0b08c2b4162c7007fba407806554a0b4f56bfcfa6b93c2644ebd2d1decd7ee53&repo_type=0&image_type=private_image&enterprise_project_id=all_granted_eps

  • Query the software information of the CI/CD image whose image_id is 111.

    GET https://{endpoint}/v5/{project_id}/image/111/apps?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" : 195,
  "data_list" : [ {
    "app_name" : "acl",
    "app_type" : "rpm",
    "app_version" : "2.2.53-7.h1.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "attr",
    "app_type" : "rpm",
    "app_version" : "2.4.48-12.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "audit",
    "app_type" : "rpm",
    "app_version" : "3.0-5.h7.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "audit-libs",
    "app_type" : "rpm",
    "app_version" : "3.0-5.h7.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "basesystem",
    "app_type" : "rpm",
    "app_version" : "12-1.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "bash",
    "app_type" : "rpm",
    "app_version" : "5.0-12.h5.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "brotli",
    "app_type" : "rpm",
    "app_version" : "1.0.7-2.h2.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "bzip2",
    "app_type" : "rpm",
    "app_version" : "1.0.8-3.h1.r1.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "ca-certificates",
    "app_type" : "rpm",
    "app_version" : "2020.2.40-1.h8.eulerosv2r9",
    "vul_num" : 0
  }, {
    "app_name" : "chkconfig",
    "app_type" : "rpm",
    "app_version" : "1.10-8.h1.eulerosv2r9",
    "vul_num" : 0
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Images