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 do relatório de verificação de configuração de espelho
Atualizado em 2024-09-14 GMT+08:00

Consulta do relatório de verificação de configuração de espelho

Função

Essa API é usada para consultar o relatório de verificação de configuração de espelho.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v5/{project_id}/image/baseline/check-rule/detail

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

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: imagem local

  • instance_image: imagem empresarial

Mínimo: 1

Máximo: 32

namespace

Não

String

Especifica o nome da organização. Se nenhuma informação de imagem estiver disponível, todas as imagens serão consultadas.

Mínimo: 0

Máximo: 64

image_name

Não

String

Nome da imagem

Mínimo: 0

Máximo: 128

image_version

Não

String

Nome da tag de imagem

Mínimo: 0

Máximo: 64

check_name

Sim

String

Nome da linha de base

Mínimo: 0

Máximo: 255

check_type

Sim

String

Tipo de linha de base

Mínimo: 0

Máximo: 255

check_rule_id

Sim

String

ID do item de verificação

Mínimo: 0

Máximo: 255

standard

Sim

String

Tipo padrão. Seu valor pode ser:

  • cn_standard: padrão de conformidade DJCP MLPS

  • hw_standard: padrão da Huawei

  • qt_standard: padrão de Qingteng

Mínimo: 0

Máximo: 32

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

description

String

Descrição do item de verificação

Mínimo: 0

Máximo: 2048

reference

String

Referência

Mínimo: 0

Máximo: 255

audit

String

Descrição da auditoria

Mínimo: 0

Máximo: 65534

remediation

String

Sugestão

Mínimo: 0

Máximo: 65534

check_info_list

Array of ImageCheckRuleCheckCaseResponseInfo objects

Caso de teste

Comprimento da matriz: 0–2147483647

Tabela 5 ImageCheckRuleCheckCaseResponseInfo

Parâmetro

Tipo

Descrição

check_description

String

Descrição do caso de teste

Mínimo: 0

Máximo: 65534

current_value

String

Resultado atual

Mínimo: 0

Máximo: 65534

suggest_value

String

Resultado esperado

Mínimo: 0

Máximo: 65534

Exemplo de solicitações

Consultar o relatório de verificação do item de configuração cuja organização é aaa, o nome da imagem é centos7, a versão da imagem é comum, o nome da linha de base é SSH, o ID do item de verificação é 1.12 e o tipo padrão é padrão da Huawei.

GET https://{endpoint}/v5/{project_id}/image/baseline/check-rule/detail?image_type=private_image&namespace=aaa&image_name=centos7&image_version=common&check_rule_id=1.12&standard=hw_standard&check_type=SSH&check_name=SSH&enterprise_project_id=all_granted_eps

Exemplo de respostas

Código de status: 200

O relatório de verificação de itens de verificação de configuração é retornado.

{
  "audit" : "Check the configuration file: /etc/pam.d/system",
  "check_info_list" : [ {
    "check_description" : "Check the configuration file: /etc/pam.d/system-auth"
  }, {
    "current_value" : ""
  }, {
    "suggest_value" : "auth required is configured for each file."
  } ],
  "description" : "The two options ClientAliveInterval and ClientAliveCountMax control the timeout of SSH sessions. The ClientAliveInterval parameter sets a timeout interval in seconds after which if no data has been received from the client, sshd will send a message through the encrypted channel to request a response from the client. The ClientAliveCountMax parameter sets the number of client alive messages which may be sent without sshd receiving any messages back from the client. For example, if the ClientAliveInterval is set to 15s and the ClientAliveCountMax is set to 3, unresponsive SSH clients will be disconnected after approximately 45s.",
  "reference" : "",
  "remediation" : "Edit the /etc/ssh/sshd_config file to set the parameter as follows: \nClientAliveInterval 300 \nClientAliveCountMax 0"
}

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

    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();
        ShowImageCheckRuleDetailRequest request = new ShowImageCheckRuleDetailRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withImageType("<image_type>");
        request.withNamespace("<namespace>");
        request.withImageName("<image_name>");
        request.withImageVersion("<image_version>");
        request.withCheckName("<check_name>");
        request.withCheckType("<check_type>");
        request.withCheckRuleId("<check_rule_id>");
        request.withStandard("<standard>");
        request.withInstanceId("<instance_id>");
        try {
            ShowImageCheckRuleDetailResponse response = client.showImageCheckRuleDetail(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
# 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 = ShowImageCheckRuleDetailRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.image_type = "<image_type>"
        request.namespace = "<namespace>"
        request.image_name = "<image_name>"
        request.image_version = "<image_version>"
        request.check_name = "<check_name>"
        request.check_type = "<check_type>"
        request.check_rule_id = "<check_rule_id>"
        request.standard = "<standard>"
        request.instance_id = "<instance_id>"
        response = client.show_image_check_rule_detail(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
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.ShowImageCheckRuleDetailRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.ImageType = "<image_type>"
	namespaceRequest:= "<namespace>"
	request.Namespace = &namespaceRequest
	imageNameRequest:= "<image_name>"
	request.ImageName = &imageNameRequest
	imageVersionRequest:= "<image_version>"
	request.ImageVersion = &imageVersionRequest
	request.CheckName = "<check_name>"
	request.CheckType = "<check_type>"
	request.CheckRuleId = "<check_rule_id>"
	request.Standard = "<standard>"
	instanceIdRequest:= "<instance_id>"
	request.InstanceId = &instanceIdRequest
	response, err := client.ShowImageCheckRuleDetail(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

O relatório de verificação de itens de verificação de configuração é retornado.

Códigos de erro

Consulte Códigos de erro.