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

Obtaining Image Software Information

Function

This API is used to obtain software information from an image.

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/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
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.

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

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.

image_type

No

String

Definition

Image type.

Constraints

N/A

Range

  • local_image: local image

  • registry: repository image

  • **cicd **: CI/CD image

Default Value

N/A

app_name

No

String

Definition

Software Name

Constraints

N/A

Range

The value can contain 0 to 32 characters.

Default Value

N/A

is_compliant

No

Boolean

Definition

Whether the data is regulation-compliant. Only false is supported.

Constraints

N/A

Range

  • true: yes.

  • false: no.

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

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 1 to 128 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: 2,147,483,547

data_list

Array of ImageAppResponseInfo objects

Definition

List.

Range

The value range is 0 to 2,147,483,647.
Table 5 ImageAppResponseInfo

Parameter

Type

Description

app_name

String

Definition

Software name.

Range

The value can contain 0 to 128 characters.

app_type

String

Definition

Software type.

Range

The value can contain 0 to 128 characters.

app_version

String

Definition

Software version.

Range

The value can contain 0 to 128 characters.

vul_num

Integer

Definition

Total number of vulnerabilities.

Range

The value range is 0 to 20,000.

app_path

String

Definition

Software path.

Range

The value can contain 0 to 128 characters.

layer_digest

String

Definition

Layer digest.

Range

The value can contain 0 to 128 characters.

is_compliant

Boolean

Definition

Whether the item is compliant. false indicates non-compliant.

Range

  • true: yes.

  • false: no.

latest_scan_time

Long

Definition

Last detection time, in ms.

Range

The value range is 0 to 9,223,372,036,854,775,807.

image_type

String

Definition

Repository image type. The options are as follows:

Range

  • SwrPrivate: SWR private image

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Harbor: Harbor repository

  • Jfrog: JFrog repository

  • Other: other repository

namespace

String

Definition

Organization name.

Range

The value can contain 0 to 65,535 characters.

image_name

String

Definition

Image name.

Range

The value can contain 0 to 65,535 characters.

image_version

String

Definition

Image tag name

Range

The value can contain 0 to 65,535 characters.

image_id

String

Definition

Image ID.

Range

The value can contain 0 to 65,535 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "app_name" : "acl",
    "app_type" : "RPM",
    "app_version" : "2.2.53-7.h1.eulerosv2r9.x86_64",
    "vul_num" : 0,
    "app_path" : "/usr",
    "layer_digest" : "sha256:bbfa5775dc0658fde7d5e85d6cb7646f106fa04de36e142653f237eefd120b4f"
  } ],
  "total_num" : 1
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Images