Help Center/ Host Security Service/ API Reference/ API Description/ Container Installation and Configuration/ Obtaining the Image Upload Command of the Scan Component
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining the Image Upload Command of the Scan Component

Function

This API is used to obtain the image upload commands of the components required for image repository access and scanning.

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/registries/image-upload-command

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

registry_addr

Yes

String

Definition

Image Repository Address

Constraints

URL or IP:Port. Example: myharbor.com

Range

Length: 1 to 256 characters

Default Value

N/A

namespace

Yes

String

Definition

Image repository project, which is used to specify the image repository directory that the scan component is to be uploaded to.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

username

Yes

String

Definition

Username for logging in to the image repository.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

password

Yes

String

Definition

Password for logging in to the image repository. The password is used only to generate commands. HSS does not store your image repository password.

Constraints

N/A

Range

Length: 1 to 128 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

image_command

String

Definition

Command for uploading an image

Range

Length: 1 to 1024 characters

images_download_url

String

Definition

Image download link

Range

Length: 1 to 256 characters

swr_image_pull_command

String

Definition

Command for obtaining an image from SWR.

Range

Length: 1 to 1024 characters

Example Requests

Obtain the image upload command. The uploaded image is required by the image repository access and scan functions. The image repository address is hub.docker.com, the organization name is test, the username is xxx, and the password is xxxxxx.

GET https://{endpoint}/v5/{project_id}/image/registries/image-upload-command?registry_addr=hub.docker.com&namespace=test&username=xxx&password=xxxxxx&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "image_command" : "docker load xxx",
  "images_download_url" : "https://xxx.zip",
  "swr_image_pull_command" : "docker pull xxx"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration