Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Host Security Service/ Referência de API/ Descrição da API/ Imagem do container/ Consulta da lista de imagens no repositório de imagens do SWR
Atualizado em 2024-09-14 GMT+08:00

Consulta da lista de imagens no repositório de imagens do SWR

Função

Essa API é usada para consultar a lista de imagens no repositório de imagens do SWR. Para sincronizar as imagens mais recentes do SWR, chame a API para sincronizar imagens do SWR primeiro.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v5/{project_id}/image/swr-repository

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto do locatário

Mínimo: 1

Máximo: 256

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

enterprise_project_id

Não

String

ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps.

Padrão: 0

Mínimo: 1

Máximo: 256

namespace

Não

String

Nome da organização

Mínimo: 1

Máximo: 256

image_name

Não

String

ID do nome da imagem

Mínimo: 1

Máximo: 128

image_version

Não

String

Tag da imagem

Mínimo: 1

Máximo: 64

latest_version

Não

Boolean

Exibir apenas as versões de imagem mais recentes

Padrão: false

offset

Não

Integer

Deslocamento, que especifica a posição inicial do registro a ser retornado. O valor deve ser um número não menor que 0. O valor padrão é 0.

Mínimo: 0

Máximo: 2000000

Padrão: 0

limit

Não

Integer

Número de registros exibidos em cada página.

Mínimo: 10

Máximo: 200

Padrão: 10

image_type

Sim

String

Tipo de imagem. As opções são as seguintes:

  • private_image: repositório privado de imagens

  • shared_image: repositório de imagens compartilhado

  • local_image

  • instance_image: imagem empresarial

Mínimo: 1

Máximo: 32

scan_status

Não

String

Status da verificação. As opções são as seguintes:

  • unscan

  • success

  • scanning

  • failed

  • waiting_for_scan

Mínimo: 0

Máximo: 32

instance_name

Não

String

Nome da instância de imagem empresarial

Mínimo: 0

Máximo: 128

image_size

Não

Long

Tamanho da imagem

Mínimo: 0

Máximo: 2147483547

Padrão: 0

start_latest_update_time

Não

Long

Hora de início da criação (ms).

Mínimo: 0

Máximo: 4070880000000

Padrão: 0

end_latest_update_time

Não

Long

Hora de término da criação (ms).

Mínimo: 0

Máximo: 4070880000000

Padrão: 0

start_latest_scan_time

Não

Long

A hora de início da última conclusão da verificação, em ms.

Mínimo: 0

Máximo: 4070880000000

Padrão: 0

end_latest_scan_time

Não

Long

A hora de término da última conclusão da verificação, em ms.

Mínimo: 0

Máximo: 4070880000000

Padrão: 0

has_malicious_file

Não

Boolean

Se existem arquivos maliciosos

has_unsafe_setting

Não

Boolean

Se a verificação de linha de base existe

has_vul

Não

Boolean

Se existem vulnerabilidades de software

instance_id

Não

String

ID da instância do repositório empresarial. Esta API não é necessária para a edição compartilhada do SWR.

Mínimo: 0

Máximo: 128

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Mínimo: 1

Máximo: 32768

region

Sim

String

ID da região

Mínimo: 0

Máximo: 128

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

total_num

Integer

Número total

Mínimo: 0

Máximo: 2147483547

data_list

Array of PrivateImageRepositoryInfo objects

Consulta da lista de imagens no repositório de imagens do SWR

Comprimento da matriz: 0–200

Tabela 5 PrivateImageRepositoryInfo

Parâmetro

Tipo

Descrição

id

Long

ID

Mínimo: 0

Máximo: 2147483547

namespace

String

Namespace

Mínimo: 0

Máximo: 64

image_name

String

Nome da imagem

Mínimo: 0

Máximo: 128

image_id

String

ID da imagem

Mínimo: 0

Máximo: 64

image_digest

String

Resumo da imagem

Mínimo: 0

Máximo: 128

image_version

String

Tag da imagem

Mínimo: 0

Máximo: 64

image_type

String

Tipo de imagem. As opções são as seguintes:

  • private_image

  • shared_image

Mínimo: 0

Máximo: 64

latest_version

Boolean

Verificar se a versão é a mais recente.

scan_status

String

Status da verificação. As opções são as seguintes:

  • unscan

  • success

  • scanning

  • failed

  • download_failed

  • image_oversized

  • waiting_for_scan

Mínimo: 0

Máximo: 64

scan_failed_desc

String

Causa da falha de verificação. As opções são as seguintes:

  • "unknown_error"

  • "authentication_failed"

  • "download_failed": falha ao fazer o download da imagem.

  • "image_over_sized": o tamanho da imagem excede o máximo.

  • "image_oversized"

  • "failed_to_scan_vulnerability"

  • "failed_to_scan_file"

  • "failed_to_scan_software"

  • "failed_to_check_sensitive_information"

  • "failed_to_check_baseline"

  • "failed_to_check_software_compliance"

  • "failed_to_query_basic_image_information"

  • "response_timed_out"

  • "database_error"

  • "failed_to_send_the_scan_request"

Mínimo: 0

Máximo: 64

image_size

Long

Tamanho da imagem

Mínimo: 0

Máximo: 2147483547

latest_update_time

Long

Hora da última atualização da versão da imagem, em ms.

Mínimo: 0

Máximo: 4070880000000

latest_scan_time

Long

Última verificação, em ms.

Mínimo: 0

Máximo: 4070880000000

vul_num

Integer

Vulnerabilidades

Mínimo: 0

Máximo: 2147483647

unsafe_setting_num

Integer

Número de verificações de linha de base com falha

Mínimo: 0

Máximo: 2147483647

malicious_file_num

Integer

Número de arquivos maliciosos

Mínimo: 0

Máximo: 2147483647

domain_name

String

Proprietário (parâmetro de imagem compartilhada)

Mínimo: 0

Máximo: 128

shared_status

String

O status de uma imagem compartilhada. O valor pode ser:

  • expired

  • effective

Mínimo: 1

Máximo: 32

scannable

Boolean

Digitalizável ou não

instance_name

String

Nome da instância da imagem da edição empresarial

Mínimo: 0

Máximo: 128

instance_id

String

ID de instância da imagem da edição empresarial

Mínimo: 0

Máximo: 64

instance_url

String

URL de instância da imagem da edição empresarial

Mínimo: 0

Máximo: 256

association_images

Array of AssociateImages objects

Informações de imagem vinculadas a várias arquiteturas

Comprimento da matriz: 0–200

Tabela 6 AssociateImages

Parâmetro

Tipo

Descrição

image_name

String

Nome da imagem

Mínimo: 0

Máximo: 128

image_version

String

Tag da imagem

Mínimo: 0

Máximo: 64

image_type

String

Tipo de imagem

Mínimo: 0

Máximo: 64

namespace

String

Namespace

Mínimo: 0

Máximo: 64

image_digest

String

Resumo da imagem

Mínimo: 0

Máximo: 128

scan_status

String

Status da verificação. As opções são as seguintes:

  • unscan

  • success

  • scanning

  • failed

  • download_failed

  • image_oversized

  • waiting_for_scan

Mínimo: 0

Máximo: 32

Exemplo de solicitações

Consultar a lista de imagens no repositório de imagens do SWR cujo tipo de imagem é imagem privada.

GET https://{endpoint}/v5/{project_id}/image/swr-repository?offset=0&limit=50&image_type=private_image&latest_version=false&enterprise_project_id=all_granted_eps

Exemplo de respostas

Código de status: 200

Essa API é usada para consultar a lista de imagens no repositório de imagens do SWR, incluindo a lista de imagens privadas e a lista de imagens compartilhadas (controladas pelo parâmetro de entrada image_type).

{
  "total_num" : 3,
  "data_list" : [ {
    "id" : "111 (example for private images)",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "centos7",
    "image_size" : "1000 (Bytes)",
    "image_type" : "private_image",
    "image_version" : "common",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "222 (example for shared image)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 (Bytes)",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "",
    "instance_id" : "",
    "instance_url" : ""
  }, {
    "id" : "333 (example of an enterprise image)",
    "domain_name" : "scc_cgs_XXX",
    "shared_status" : "effective",
    "image_digest" : "sha256:cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_id" : "cebcdacde18091448a5040dc55bb1a9f6540b093db8XXXXXX",
    "image_name" : "mysql",
    "image_size" : "1000 (Bytes)",
    "image_type" : "shared_image",
    "image_version" : "5.5",
    "latest_scan_time" : 1691748641788,
    "latest_update_time" : 1687664346000,
    "latest_version" : false,
    "malicious_file_num" : 0,
    "namespace" : "aaa",
    "scan_status" : "success",
    "scannable" : true,
    "unsafe_setting_num" : 1,
    "vul_num" : 111,
    "instance_name" : "Enterprise instance name",
    "instance_id" : "",
    "instance_url" : ""
  } ]
}

Código de amostra do SDK

O código de amostra do SDK é o seguinte.

Java

 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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 ListSwrImageRepositorySolution {

    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");

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

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSwrImageRepositoryRequest request = new ListSwrImageRepositoryRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withNamespace("<namespace>");
        request.withImageName("<image_name>");
        request.withImageVersion("<image_version>");
        request.withLatestVersion(<latest_version>);
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withImageType("<image_type>");
        request.withScanStatus("<scan_status>");
        request.withInstanceName("<instance_name>");
        request.withImageSize(<image_size>L);
        request.withStartLatestUpdateTime(<start_latest_update_time>L);
        request.withEndLatestUpdateTime(<end_latest_update_time>L);
        request.withStartLatestScanTime(<start_latest_scan_time>L);
        request.withEndLatestScanTime(<end_latest_scan_time>L);
        request.withHasMaliciousFile(<has_malicious_file>);
        request.withHasUnsafeSetting(<has_unsafe_setting>);
        request.withHasVul(<has_vul>);
        request.withInstanceId("<instance_id>");
        try {
            ListSwrImageRepositoryResponse response = client.listSwrImageRepository(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());
        }
    }
}

Python

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListSwrImageRepositoryRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.namespace = "<namespace>"
        request.image_name = "<image_name>"
        request.image_version = "<image_version>"
        request.latest_version = <LatestVersion>
        request.offset = <offset>
        request.limit = <limit>
        request.image_type = "<image_type>"
        request.scan_status = "<scan_status>"
        request.instance_name = "<instance_name>"
        request.image_size = <image_size>
        request.start_latest_update_time = <start_latest_update_time>
        request.end_latest_update_time = <end_latest_update_time>
        request.start_latest_scan_time = <start_latest_scan_time>
        request.end_latest_scan_time = <end_latest_scan_time>
        request.has_malicious_file = <HasMaliciousFile>
        request.has_unsafe_setting = <HasUnsafeSetting>
        request.has_vul = <HasVul>
        request.instance_id = "<instance_id>"
        response = client.list_swr_image_repository(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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")

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

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

    request := &model.ListSwrImageRepositoryRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	namespaceRequest:= "<namespace>"
	request.Namespace = &namespaceRequest
	imageNameRequest:= "<image_name>"
	request.ImageName = &imageNameRequest
	imageVersionRequest:= "<image_version>"
	request.ImageVersion = &imageVersionRequest
	latestVersionRequest:= <latest_version>
	request.LatestVersion = &latestVersionRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	request.ImageType = "<image_type>"
	scanStatusRequest:= "<scan_status>"
	request.ScanStatus = &scanStatusRequest
	instanceNameRequest:= "<instance_name>"
	request.InstanceName = &instanceNameRequest
	imageSizeRequest:= int64(<image_size>)
	request.ImageSize = &imageSizeRequest
	startLatestUpdateTimeRequest:= int64(<start_latest_update_time>)
	request.StartLatestUpdateTime = &startLatestUpdateTimeRequest
	endLatestUpdateTimeRequest:= int64(<end_latest_update_time>)
	request.EndLatestUpdateTime = &endLatestUpdateTimeRequest
	startLatestScanTimeRequest:= int64(<start_latest_scan_time>)
	request.StartLatestScanTime = &startLatestScanTimeRequest
	endLatestScanTimeRequest:= int64(<end_latest_scan_time>)
	request.EndLatestScanTime = &endLatestScanTimeRequest
	hasMaliciousFileRequest:= <has_malicious_file>
	request.HasMaliciousFile = &hasMaliciousFileRequest
	hasUnsafeSettingRequest:= <has_unsafe_setting>
	request.HasUnsafeSetting = &hasUnsafeSettingRequest
	hasVulRequest:= <has_vul>
	request.HasVul = &hasVulRequest
	instanceIdRequest:= "<instance_id>"
	request.InstanceId = &instanceIdRequest
	response, err := client.ListSwrImageRepository(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

Mais

Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.

Códigos de status

Código de status

Descrição

200

Essa API é usada para consultar a lista de imagens no repositório de imagens do SWR, incluindo a lista de imagens privadas e a lista de imagens compartilhadas (controladas pelo parâmetro de entrada image_type).

Códigos de erro

Consulte Códigos de erro.