Help Center/ Host Security Service/ API Reference/ API Description/ Container Installation and Configuration/ Obtaining the Image Upload Command of a Multi-Cloud Cluster
Updated on 2025-09-08 GMT+08:00

Obtaining the Image Upload Command of a Multi-Cloud Cluster

Function

This API is used to obtain the image upload command of a multi-cloud cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/container/kubernetes/multi-cloud/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

image_repo

Yes

String

Image repository address

organization

Yes

String

Organization name

username

Yes

String

User Name

password

Yes

String

Password

plug_type

No

String

Parameter description:

Plug-in type

Constraints:

N/A

Options:

  • docker: Docker plug-in image

  • agent: hostguard image

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

Command for uploading an image

secret_command

String

Installation credential command

images_download_url

String

Image download link

Example Requests

Obtain the image upload command of a multi-cloud cluster. The image repository is hub.docker.com, the username is ywkkkkkkk, the organization name is ywk-test, and the password is agent@2023.

GET https://{endpoint}/v5/{project_id}/container/kubernetes/multi-cloud/image-upload-command?image_repo=hub.docker.com&username=ywkkkkkkk&organization=ywk-test&password=agent@2023&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "image_command" : "unzip hss-images.zip && docker load < anp-agent-arm64.tar.gz &&\\\r\ndocker login -u nhhh -p agent@2023 hub.docker.com &&\\\r\ndocker load < anp-agent-x86_64.tar.gz &&\\\r\ndocker tag proxy-agent:0.0.27-x86_64 hub.docker.com/ywk-test/anp-agent:${anp-version}.x86_64 &&\\\r\ndocker push hub.docker.com/ywk-test/anp-agent:${anp-version}.x86_64 &&\\\r\ndocker tag proxy-agent:0.0.27-aarch64 hub.docker.com/ywk-test/anp-agent:${anp-version}.arm64 &&\\\r\ndocker push hub.docker.com/ywk-test/anp-agent:${anp-version}.arm64 &&\\\r\ndocker manifest create --insecure hub.docker.com/ywk-test/anp-agent:${anp-version} hub.docker.com/ywk-test/anp-agent:${anp-version}.x86_64 hub.docker.com/ywk-test/anp-agent:${anp-version}.arm64 --amend &&\\\r\ndocker manifest annotate hub.docker.com/ywk-test/anp-agent:${anp-version} hub.docker.com/ywk-test/anp-agent:${anp-version}.x86_64 --os linux --arch amd64 &&\\\r\ndocker manifest annotate hub.docker.com/ywk-test/anp-agent:${anp-version} hub.docker.com/ywk-test/anp-agent:${anp-version}.arm64 --os linux --arch arm64 &&\\\r\ndocker manifest push --insecure hub.docker.com/ywk-test/anp-agent:${anp-version} &&\\\r\ndocker load < hostguard-image-3.2.12.aarch64.tar.gz &&\\\r\ndocker load < hostguard-image-3.2.12.x86_64.tar.gz &&\\\r\ndocker tag registry-cbu.huawei.com/scc_hss_container/hostguard:3.2.12.x86_64 hub.docker.com/ywk-test/hostguard:3.2.12.x86_64 &&\\\r\ndocker push hub.docker.com/ywk-test/hostguard:3.2.12.x86_64 &&\\\r\ndocker tag registry-cbu.huawei.com/scc_hss_container/hostguard:3.2.12.aarch64 hub.docker.com/ywk-test/hostguard:3.2.12.aarch64 &&\\\r\ndocker push hub.docker.com/ywk-test/hostguard:3.2.12.aarch64 &&\\\r\ndocker manifest create --insecure hub.docker.com/ywk-test/hostguard:3.2.12 hub.docker.com/ywk-test/hostguard:3.2.12.x86_64 hub.docker.com/ywk-test/hostguard:3.2.12.aarch64 --amend &&\\\r\ndocker manifest annotate hub.docker.com/ywk-test/hostguard:3.2.12 hub.docker.com/ywk-test/hostguard:3.2.12.x86_64 --os linux --arch amd64 &&\\\r\ndocker manifest annotate hub.docker.com/ywk-test/hostguard:3.2.12 hub.docker.com/ywk-test/hostguard:3.2.12.aarch64 --os linux --arch arm64 &&\\\r\ndocker manifest push --insecure hub.docker.com/ywk-test/hostguard:3.2.12",
  "secret_command" : "kubectl --namespace hss create secret docker-registry hss-regcred --docker-server=hub.docker.com --docker-username=nhhh --docker-password=agent@2023",
  "images_download_url" : "https://100.93.1.146:10180/package/rule/anpAgent/hss-images.zip"
}

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
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 ShowMultiCloudClusterImageCommandSolution {

    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();
        ShowMultiCloudClusterImageCommandRequest request = new ShowMultiCloudClusterImageCommandRequest();
        try {
            ShowMultiCloudClusterImageCommandResponse response = client.showMultiCloudClusterImageCommand(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
# 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 = ShowMultiCloudClusterImageCommandRequest()
        response = client.show_multi_cloud_cluster_image_command(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
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.ShowMultiCloudClusterImageCommandRequest{}
	response, err := client.ShowMultiCloudClusterImageCommand(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.