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/ Prevenção contra ransomware/ Consulta da lista de políticas de proteção contra ransomware
Atualizado em 2024-09-14 GMT+08:00

Consulta da lista de políticas de proteção contra ransomware

Função

Essa API é usada para consultar a lista de políticas de proteção contra ransomware.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v5/{project_id}/ransomware/protection/policy

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto

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

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

policy_name

Não

String

Nome da política

Mínimo: 0

Máximo: 128

protect_policy_id

Não

String

ID da política

Mínimo: 0

Máximo: 128

operating_system

Não

String

SOs suportados pela política. As opções são as seguintes:

  • Windows

  • Linux

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 de políticas

Mínimo: 0

Máximo: 2097152

data_list

Array of ProtectionPolicyInfo objects

Consultar a lista de políticas.

Comprimento da matriz: 0–10241

Tabela 5 ProtectionPolicyInfo

Parâmetro

Tipo

Descrição

policy_id

String

ID da política

Mínimo: 0

Máximo: 128

policy_name

String

Nome da política

Mínimo: 0

Máximo: 128

protection_mode

String

Ação. Seu valor pode ser:

  • alarm_and_isolation: relatar um alarme e isolar.

  • alarm_only: relatar apenas alarmes.

Mínimo: 0

Máximo: 128

bait_protection_status

String

Se deve ativar a proteção de honeypot. Por padrão, a proteção está ativada. Seu valor pode ser:

  • opened

  • closed

Mínimo: 0

Máximo: 128

deploy_mode

String

Se deve ativar a proteção de honeypot. As opções são as seguintes. Por padrão, a proteção dinâmica de honeypot está desativada.

  • opened

  • closed

Mínimo: 0

Máximo: 128

protection_directory

String

Diretório protegido

Mínimo: 1

Máximo: 128

protection_type

String

Tipo de arquivo protegido, por exemplo, .docx, .txt e .avi.

Mínimo: 0

Máximo: 128

exclude_directory

String

(Opcional) Diretório excluído

Mínimo: 1

Máximo: 128

runtime_detection_status

String

Se devem ser realizadas verificações de tempo de execução. As opções são as seguintes. Atualmente, ele só pode ser desativado. Este campo está reservado.

  • opened

  • closed

Mínimo: 0

Máximo: 128

runtime_detection_directory

String

Diretório a ser verificado durante a execução. Este campo está reservado.

Mínimo: 1

Máximo: 128

count_associated_server

Integer

Número de servidores vinculados

Mínimo: 0

Máximo: 2097152

operating_system

String

Tipo de SO.

  • Linux

  • Windows

Mínimo: 0

Máximo: 128

process_whitelist

Array of TrustProcessInfo objects

Lista branca do processo

Comprimento da matriz: 0–20

default_policy

Integer

Indica se a política é a política padrão. As opções são as seguintes:

  • 0: política não padrão

  • 1: política padrão

Mínimo: 0

Máximo: 10

Tabela 6 TrustProcessInfo

Parâmetro

Tipo

Descrição

path

String

Indica o caminho do processo.

Mínimo: 0

Máximo: 128

hash

String

Hash do processo

Mínimo: 0

Máximo: 128

Exemplo de solicitações

Consultar a lista de políticas de proteção contra ransomware. Se o limite não for especificado, 10 registros serão retornados por padrão.

GET https://{endpoint}/v5/{project_id}/ransomware/protection/policy

Exemplo de respostas

Código de status: 200

Lista de políticas de proteção

{
  "total_num" : 1,
  "data_list" : [ {
    "bait_protection_status" : "opened",
    "exclude_directory" : "/opt",
    "count_associated_server" : 0,
    "operating_system" : "Linux",
    "protection_mode" : "alarm_only",
    "policy_id" : "4117d16-074b-41ae-b7d7-9cc25ee258",
    "policy_name" : "test",
    "protection_directory" : "/dd",
    "protection_type" : "docx",
    "runtime_detection_status" : "closed"
  } ]
}

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

    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();
        ListProtectionPolicyRequest request = new ListProtectionPolicyRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withPolicyName("<policy_name>");
        request.withProtectPolicyId("<protect_policy_id>");
        request.withOperatingSystem("<operating_system>");
        try {
            ListProtectionPolicyResponse response = client.listProtectionPolicy(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
# 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 = ListProtectionPolicyRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.offset = <offset>
        request.limit = <limit>
        request.policy_name = "<policy_name>"
        request.protect_policy_id = "<protect_policy_id>"
        request.operating_system = "<operating_system>"
        response = client.list_protection_policy(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
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.ListProtectionPolicyRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	policyNameRequest:= "<policy_name>"
	request.PolicyName = &policyNameRequest
	protectPolicyIdRequest:= "<protect_policy_id>"
	request.ProtectPolicyId = &protectPolicyIdRequest
	operatingSystemRequest:= "<operating_system>"
	request.OperatingSystem = &operatingSystemRequest
	response, err := client.ListProtectionPolicy(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 políticas de proteção

Códigos de erro

Consulte Códigos de erro.