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/ Gerenciamento de linha de base/ Consulta da lista de verificação de um item de configuração de segurança
Atualizado em 2024-09-14 GMT+08:00

Consulta da lista de verificação de um item de configuração de segurança

Função

Esta API é usada para consultar a lista de verificação de um item de configuração de segurança especificado.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v5/{project_id}/baseline/risk-config/{check_name}/check-rules

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto

Mínimo: 20

Máximo: 64

check_name

Sim

String

Nome da linha de base, por exemplo, SSH, CentOS 7 e Windows.

Mínimo: 0

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.

Mínimo: 0

Máximo: 64

standard

Sim

String

Tipo padrão. Seu valor pode ser:

  • cn_standard: padrão de conformidade DJCP MLPS

  • hw_standard: padrão de prática de segurança na nuvem

Mínimo: 0

Máximo: 32

result_type

Não

String

Tipo de resultado. Seu valor pode ser:

  • safe: o item passou na verificação.

  • unhandled: o item falhou na verificação e não é ignorado.

  • ignored: o item falhou na verificação, mas foi ignorado.

Padrão: unhandled

Mínimo: 0

Máximo: 64

check_rule_name

Não

String

Nome do item de verificação. A correspondência difusa é suportada.

Mínimo: 0

Máximo: 2048

severity

Não

String

Nível de risco. Seu valor pode ser:

  • Security

  • Low

  • Medium

  • High

  • Critical

Mínimo: 0

Máximo: 255

host_id

Não

String

ID do servidor. Se esse parâmetro não for especificado, todos os servidores do usuário serão consultados.

Mínimo: 0

Máximo: 64

limit

Não

Integer

Número de itens por página

Mínimo: 0

Máximo: 200

Padrão: 10

offset

Não

Integer

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

Mínimo: 0

Máximo: 2000000

Padrão: 0

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: 32

Máximo: 2097152

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

total_num

Long

Riscos totais

Mínimo: 0

Máximo: 9223372036854775807

data_list

Array of CheckRuleRiskInfoResponseInfo objects

Lista de dados

Comprimento da matriz: 0–2147483647

Tabela 5 CheckRuleRiskInfoResponseInfo

Parâmetro

Tipo

Descrição

severity

String

Nível de risco. Seu valor pode ser:

  • Low

  • Medium

  • High

Mínimo: 0

Máximo: 255

check_name

String

Nome da linha de base, por exemplo, SSH, CentOS 7 e Windows.

Mínimo: 0

Máximo: 256

check_type

String

Tipo de linha de base. Os valores de check_type e check_name são os mesmos para servidores Linux. Por exemplo, ambos podem ser definidos como SSH ou CentOS 7. Para servidores Windows, os valores de check_type e check_name são diferentes. Por exemplo, check_type pode ser definido como Windows Server 2019 R2 ou Windows Server 2016 R2.

Mínimo: 0

Máximo: 256

standard

String

Tipo padrão. Seu valor pode ser:

  • cn_standard: padrão de conformidade DJCP MLPS

  • hw_standard: padrão de prática de segurança na nuvem

Mínimo: 0

Máximo: 16

check_rule_name

String

Nome do item de verificação

Mínimo: 0

Máximo: 2048

check_rule_id

String

ID do item de verificação

Mínimo: 0

Máximo: 64

host_num

Integer

O número de servidores nos quais a detecção de linha de base atual é executada.

Mínimo: 0

Máximo: 2147483647

scan_result

String

Resultado da detecção. Seu valor pode ser:

  • pass

  • failed

Mínimo: 0

Máximo: 64

status

String

Status. Seu valor pode ser:

  • safe

  • ignored

  • unhandled

  • fixing

  • fix-failed

  • verifying

Mínimo: 0

Máximo: 64

enable_fix

Integer

Indica se há suporte para reparo com um clique. 1: sim; 0: não.

Mínimo: 0

Máximo: 2147483647

enable_click

Boolean

Indica se os botões reparar, ignorar e verificar do item de verificação podem ser clicados. true: o botão pode ser clicado. false: o botão não pode ser clicado.

rule_params

Array of CheckRuleFixParamInfo objects

Intervalo de parâmetros aplicáveis aos itens de verificação que podem ser corrigidos por transferência de parâmetros. Esse parâmetro é retornado apenas para itens de verificação que oferecem suporte à correção de transferência de parâmetro.

Comprimento da matriz: 0–2147483647

Tabela 6 CheckRuleFixParamInfo

Parâmetro

Tipo

Descrição

rule_param_id

Integer

ID do parâmetro do item de verificação

Mínimo: 0

Máximo: 10

rule_desc

String

Descrição do parâmetro do item de verificação

Mínimo: 0

Máximo: 256

default_value

Integer

Valores padrão dos parâmetros do item de verificação

Mínimo: 0

Máximo: 2147483647

range_min

Integer

Valor mínimo dos parâmetros do item de verificação

Mínimo: 0

Máximo: 2147483647

range_max

Integer

Valor mínimo dos parâmetros do item de verificação

Mínimo: 0

Máximo: 2147483647

Exemplo de solicitações

Essa API é usada para consultar os itens de verificação cujo nome de linha de base é SSH, o padrão de verificação é o padrão de prática de segurança na nuvem e o ID do projeto empresarial é xxx.

GET https://{endpoint}/v5/{project_id}/baseline/risk-config/SSH/check-rules?standard=hw_standard&enterprise_project_id=xxx

{
  "standard" : "hw_standard"
}

Exemplo de respostas

Código de status: 200

Lista de verificação do item de configuração de segurança especificado

{
  "total_num" : 1,
  "data_list" : [ {
    "check_rule_id" : "1.1",
    "check_rule_name" : "Rule:Ensure that permissions on /etc/ssh/sshd_config are configured.",
    "check_type" : "SSH",
    "host_num" : 2,
    "standard" : "hw_standard",
    "scan_result" : "failed",
    "severity" : "High",
    "status" : "unhandled",
    "enable_fix" : 1,
    "enable_click" : true,
    "rule_params" : [ {
      "rule_param_id" : 1,
      "rule_desc" : "Set the timeout duration.",
      "default_value" : 5,
      "range_min" : 1,
      "range_max" : 10
    }, {
      "rule_param_id" : 2,
      "rule_desc" : "Set the number of restarts.",
      "default_value" : 10,
      "range_min" : 1,
      "range_max" : 20
    } ]
  } ]
}

Código de amostra do SDK

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

Java

Essa API é usada para consultar os itens de verificação cujo nome de linha de base é SSH, o padrão de verificação é o padrão de prática de segurança na nuvem e o ID do projeto empresarial é xxx.

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

    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();
        ListRiskConfigCheckRulesRequest request = new ListRiskConfigCheckRulesRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withStandard("<standard>");
        request.withResultType("<result_type>");
        request.withCheckRuleName("<check_rule_name>");
        request.withSeverity("<severity>");
        request.withHostId("<host_id>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListRiskConfigCheckRulesResponse response = client.listRiskConfigCheckRules(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

Essa API é usada para consultar os itens de verificação cujo nome de linha de base é SSH, o padrão de verificação é o padrão de prática de segurança na nuvem e o ID do projeto empresarial é xxx.

 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
# 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 = ListRiskConfigCheckRulesRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.standard = "<standard>"
        request.result_type = "<result_type>"
        request.check_rule_name = "<check_rule_name>"
        request.severity = "<severity>"
        request.host_id = "<host_id>"
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_risk_config_check_rules(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

Essa API é usada para consultar os itens de verificação cujo nome de linha de base é SSH, o padrão de verificação é o padrão de prática de segurança na nuvem e o ID do projeto empresarial é xxx.

 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.ListRiskConfigCheckRulesRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.Standard = "<standard>"
	resultTypeRequest:= "<result_type>"
	request.ResultType = &resultTypeRequest
	checkRuleNameRequest:= "<check_rule_name>"
	request.CheckRuleName = &checkRuleNameRequest
	severityRequest:= "<severity>"
	request.Severity = &severityRequest
	hostIdRequest:= "<host_id>"
	request.HostId = &hostIdRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListRiskConfigCheckRules(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

Lista de verificação do item de configuração de segurança especificado

Códigos de erro

Consulte Códigos de erro.