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/ Ativação da prevenção contra ransomware
Atualizado em 2024-09-14 GMT+08:00
Ver PDF
Compartilhar

Ativação da prevenção contra ransomware

Função

Para ativar a proteção contra ransomware, certifique-se de que o CBR esteja disponível na região. A prevenção contra ransomware funciona com o CBR.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

POST /v5/{project_id}/ransomware/protection/open

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

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
Tabela 4 Parâmetros do corpo da solicitação

Parâmetro

Obrigatório

Tipo

Descrição

operating_system

Sim

String

SOs do servidor a ser protegido. As opções são as seguintes:

  • Windows

  • Linux

Mínimo: 0

Máximo: 64

ransom_protection_status

Sim

String

Se a proteção contra ransomware está ativada. Seu valor pode ser:

  • closed

  • opened. Se esse parâmetro estiver ativado, protection_policy_id ou create_protection_policy deverá ser especificado.

Mínimo: 0

Máximo: 64

protection_policy_id

Não

String

ID da política de proteção contra ransomware. Se você selecionar uma política existente, esse parâmetro será obrigatório.

Mínimo: 0

Máximo: 64

create_protection_policy

Não

ProtectionProxyInfoRequestInfo object

Crie uma política de proteção. Para uma nova política de proteção, deixe protection_policy_id em branco e especifique create_protection_policy.

backup_protection_status

Sim

String

Se deve fazer backup dos dados no servidor. Seu valor pode ser:

  • closed

  • opened. Se o backup do servidor estiver ativado, backup_cycle será obrigatório.

Mínimo: 0

Máximo: 64

backup_resources

Não

BackupResources object

Este parâmetro é obrigatório quando a função de backup está ativada. Se este parâmetro estiver vazio, o cofre vinculado ao HSS_projectid é compatível.

backup_policy_id

Não

String

ID da política de backup

Mínimo: 0

Máximo: 64

backup_cycle

Não

UpdateBackupPolicyRequestInfo1 object

Política de backup.

agent_id_list

Sim

Array of strings

IDs de agentes em que a proteção está ativada

Mínimo: 0

Máximo: 64

Comprimento da matriz: 0–24

host_id_list

Sim

Array of strings

IDs dos servidores em que a proteção está ativada

Mínimo: 0

Máximo: 64

Comprimento da matriz: 0–24
Tabela 5 ProtectionProxyInfoRequestInfo

Parâmetro

Obrigatório

Tipo

Descrição

policy_id

Não

String

ID da política. Este parâmetro é opcional para uma nova política.

Mínimo: 0

Máximo: 64

policy_name

Não

String

Nome da política. Este parâmetro é obrigatório quando você cria uma política de proteção.

Mínimo: 0

Máximo: 64

protection_mode

Não

String

Ação de proteção. Este parâmetro é obrigatório quando você cria uma política de proteção. As opções são as seguintes:

  • alarm_and_isolation: relatar um alarme e isolar.

  • alarm_only: relatar apenas alarmes.

Mínimo: 0

Máximo: 64

bait_protection_status

Não

String

Se deve ativar a proteção de honeypot. Este parâmetro é obrigatório quando você cria uma política de proteção. As opções são as seguintes. Por padrão, a proteção de honeypot está ativada.

  • opened

  • closed

Mínimo: 0

Máximo: 64

protection_directory

Não

String

Diretório protegido. Este parâmetro é obrigatório quando você cria uma política de proteção.

Mínimo: 0

Máximo: 64

protection_type

Não

String

Tipo de proteção. Este parâmetro é obrigatório quando você cria uma política de proteção.

Mínimo: 0

Máximo: 64

exclude_directory

Não

String

(Opcional) Diretório excluído

Mínimo: 0

Máximo: 64

runtime_detection_status

Não

String

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

  • opened

  • closed

Mínimo: 0

Máximo: 64

operating_system

Não

String

Sistema operacional. Este parâmetro é obrigatório quando você cria uma política de proteção. Seu valor pode ser:

  • Windows

  • Linux

Mínimo: 0

Máximo: 64

process_whitelist

Não

Array of TrustProcessInfo objects

Lista branca do processo

Comprimento da matriz: 0–20
Tabela 6 TrustProcessInfo

Parâmetro

Obrigatório

Tipo

Descrição

path

Não

String

Indica o caminho do processo.

Mínimo: 0

Máximo: 128

hash

Não

String

Hash do processo

Mínimo: 0

Máximo: 128
Tabela 7 BackupResources

Parâmetro

Obrigatório

Tipo

Descrição

vault_id

Não

String

Selecione o ID do cofre a ser vinculado. O valor não pode ser vazio.

Mínimo: 0

Máximo: 64

resource_list

Não

Array of ResourceInfo objects

Lista de servidores para os quais a função de backup precisa ser ativada

Comprimento da matriz: 0–20
Tabela 8 ResourceInfo

Parâmetro

Obrigatório

Tipo

Descrição

host_id

Não

String

ID de servidor

Mínimo: 0

Máximo: 128

history_backup_status

Não

String

Se deve ativar o status de backup depende de error_message ou o status dos servidores disponíveis. Se error_message estiver vazio, o backup não será ativado e o valor desse campo será fechado. Se error_message não estiver vazio, o valor deste campo será aberto.

Mínimo: 0

Máximo: 128
Tabela 9 UpdateBackupPolicyRequestInfo1

Parâmetro

Obrigatório

Tipo

Descrição

enabled

Não

Boolean

Se a política está ativada. O valor padrão é true.

policy_id

Não

String

ID da política. Este parâmetro é obrigatório se a proteção de backup estiver ativada.

Mínimo: 1

Máximo: 256

operation_definition

Não

OperationDefinitionRequestInfo object

Parâmetro de agendamento.

trigger

Não

BackupTriggerRequestInfo1 object

Regra de agendamento de tempo para a política.
Tabela 10 OperationDefinitionRequestInfo

Parâmetro

Obrigatório

Tipo

Descrição

day_backups

Não

Integer

Número máximo de backups diários retidos. O último backup de cada dia é salvo a longo prazo. Esse parâmetro não é afetado pelo número máximo de backups retidos. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Valor mínimo: 0. Valor máximo: 100

Mínimo: 0

Máximo: 100

max_backups

Não

Integer

Número máximo de backups automatizados que podem ser retidos para um objeto. O valor pode ser -1 ou varia de 0 a 99999. Se o valor for definido como -1, os backups não serão apagados mesmo que o limite de quantidade de backups retidos configurado seja excedido. Se esse parâmetro e retention_duration_days forem deixados em branco ao mesmo tempo, os backups serão retidos permanentemente. Valor mínimo: 1. Valor máximo: 99999. Valor padrão: -1

Mínimo: -1

Máximo: 99999

month_backups

Não

Integer

Número máximo de backups mensais retidos. O último backup de cada mês é salvo a longo prazo. Esse parâmetro não é afetado pelo número máximo de backups retidos. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Valor mínimo: 0. Valor máximo: 100

Mínimo: 0

Máximo: 100

retention_duration_days

Não

Integer

Duração da retenção de um backup, em dias. O valor máximo é 99999. Se o valor for definido como -1, os backups não serão apagados mesmo que a duração de retenção configurada seja excedida. Se este parâmetro e max_backups forem deixados em branco ao mesmo tempo, os backups serão retidos permanentemente. Valor mínimo: 1. Valor máximo: 99999. Valor padrão: -1

Mínimo: -1

Máximo: 99999

timezone

Não

String

Fuso horário em que o usuário está localizado, por exemplo, UTC+08:00. Defina esse parâmetro somente depois de configurar qualquer um dos parâmetros day_backups, week_backups, month_backups e year_backups.

Mínimo: 0

Máximo: 256

week_backups

Não

Integer

Número máximo de backups semanais retidos. O último backup de cada semana é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificado por max_backups. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado.

Mínimo: 0

Máximo: 100

year_backups

Não

Integer

Número máximo de backups anuais retidos. O último backup de cada ano é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificado por max_backups. O valor varia de 0 a 100. Se este parâmetro for especificado, o fuso horário deve ser configurado. Valor mínimo: 0. Valor máximo: 100

Mínimo: 0

Máximo: 100
Tabela 11 BackupTriggerRequestInfo1

Parâmetro

Obrigatório

Tipo

Descrição

properties

Não

BackupTriggerPropertiesRequestInfo1 object

Regra de tempo para execução da política. Este parâmetro é obrigatório se a função de backup estiver ativada com proteção contra ransomware.
Tabela 12 BackupTriggerPropertiesRequestInfo1

Parâmetro

Obrigatório

Tipo

Descrição

pattern

Não

Array of strings

Regra de agendamento. Este parâmetro é obrigatório se a função de backup estiver ativada com proteção contra ransomware. Um máximo de 24 regras podem ser configuradas. A regra de agendamento está em conformidade com iCalendar RFC 2445, mas suporta apenas os parâmetros FREQ, BYDAY, BYHOUR, BYMINUTE e INTERVAL. FREQ pode ser definido apenas como WEEKLY ou DAILY. BYDAY pode ser definido como MO, TU, WE, TH, FR, SA ou SU (sete dias por semana). BYHOUR varia de 0 a 23 horas. BYMINUTE varia de 0 minutos a 59 minutos. O intervalo de agendamento não deve ser inferior a 1 hora. Um máximo de 24 pontos de tempo são permitidos em um dia. Por exemplo, se o horário de agendamento for 14:00 de segunda a domingo, defina a regra de agendamento da seguinte forma: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. Para iniciar o agendamento às 14:00 todos os dias, a regra é a seguinte: FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'.

Mínimo: 1

Máximo: 256

Comprimento da matriz: 0–24

Parâmetros de resposta

Nenhum

Exemplo de solicitações

Ativar a proteção contra ransomware para o servidor. O tipo de SO é Linux, o ID do servidor de destino é 71a15ecc-049f-4cca-bd28-5e90aca1817f, e o ID do agente do servidor de destino é c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8. O backup do servidor está desativado.

POST https://{endpoint}/v5/{project_id}/ransomware/protection/open

{
  "ransom_protection_status" : "opened",
  "backup_protection_status" : "closed",
  "operating_system" : "Linux",
  "protection_policy_id" : "",
  "agent_id_list" : [ "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8" ],
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
  "create_protection_policy" : {
    "bait_protection_status" : "opened",
    "exclude_directory" : "",
    "protection_mode" : "alarm_only",
    "policy_name" : "test111",
    "protection_directory" : "/etc/test",
    "protection_type" : "docx"
  }
}

Exemplo de respostas

Nenhum

Código de amostra do SDK

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

Java

Ativar a proteção contra ransomware para o servidor. O tipo de SO é Linux, o ID do servidor de destino é 71a15ecc-049f-4cca-bd28-5e90aca1817f, e o ID do agente do servidor de destino é c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8. O backup do servidor está desativado.

 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
 
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.*;

import java.util.List;
import java.util.ArrayList;

public class StartProtectionSolution {

    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();
        StartProtectionRequest request = new StartProtectionRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        ProtectionInfoRequestInfo body = new ProtectionInfoRequestInfo();
        List<String> listbodyHostIdList = new ArrayList<>();
        listbodyHostIdList.add("71a15ecc-049f-4cca-bd28-5e90aca1817f");
        List<String> listbodyAgentIdList = new ArrayList<>();
        listbodyAgentIdList.add("c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8");
        ProtectionProxyInfoRequestInfo createProtectionPolicybody = new ProtectionProxyInfoRequestInfo();
        createProtectionPolicybody.withPolicyName("test111")
            .withProtectionMode("alarm_only")
            .withBaitProtectionStatus("opened")
            .withProtectionDirectory("/etc/test")
            .withProtectionType("docx")
            .withExcludeDirectory("");
        body.withHostIdList(listbodyHostIdList);
        body.withAgentIdList(listbodyAgentIdList);
        body.withBackupProtectionStatus("closed");
        body.withCreateProtectionPolicy(createProtectionPolicybody);
        body.withProtectionPolicyId("");
        body.withRansomProtectionStatus("opened");
        body.withOperatingSystem("Linux");
        request.withBody(body);
        try {
            StartProtectionResponse response = client.startProtection(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

Ativar a proteção contra ransomware para o servidor. O tipo de SO é Linux, o ID do servidor de destino é 71a15ecc-049f-4cca-bd28-5e90aca1817f, e o ID do agente do servidor de destino é c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8. O backup do servidor está desativado.

 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
 
# 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 = StartProtectionRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        listHostIdListbody = [
            "71a15ecc-049f-4cca-bd28-5e90aca1817f"
        ]
        listAgentIdListbody = [
            "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8"
        ]
        createProtectionPolicybody = ProtectionProxyInfoRequestInfo(
            policy_name="test111",
            protection_mode="alarm_only",
            bait_protection_status="opened",
            protection_directory="/etc/test",
            protection_type="docx",
            exclude_directory=""
        )
        request.body = ProtectionInfoRequestInfo(
            host_id_list=listHostIdListbody,
            agent_id_list=listAgentIdListbody,
            backup_protection_status="closed",
            create_protection_policy=createProtectionPolicybody,
            protection_policy_id="",
            ransom_protection_status="opened",
            operating_system="Linux"
        )
        response = client.start_protection(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

Ativar a proteção contra ransomware para o servidor. O tipo de SO é Linux, o ID do servidor de destino é 71a15ecc-049f-4cca-bd28-5e90aca1817f, e o ID do agente do servidor de destino é c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8. O backup do servidor está desativado.

 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
 
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.StartProtectionRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	var listHostIdListbody = []string{
        "71a15ecc-049f-4cca-bd28-5e90aca1817f",
    }
	var listAgentIdListbody = []string{
        "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8",
    }
	policyNameCreateProtectionPolicy:= "test111"
	protectionModeCreateProtectionPolicy:= "alarm_only"
	baitProtectionStatusCreateProtectionPolicy:= "opened"
	protectionDirectoryCreateProtectionPolicy:= "/etc/test"
	protectionTypeCreateProtectionPolicy:= "docx"
	excludeDirectoryCreateProtectionPolicy:= ""
	createProtectionPolicybody := &model.ProtectionProxyInfoRequestInfo{
		PolicyName: &policyNameCreateProtectionPolicy,
		ProtectionMode: &protectionModeCreateProtectionPolicy,
		BaitProtectionStatus: &baitProtectionStatusCreateProtectionPolicy,
		ProtectionDirectory: &protectionDirectoryCreateProtectionPolicy,
		ProtectionType: &protectionTypeCreateProtectionPolicy,
		ExcludeDirectory: &excludeDirectoryCreateProtectionPolicy,
	}
	protectionPolicyIdProtectionInfoRequestInfo:= ""
	request.Body = &model.ProtectionInfoRequestInfo{
		HostIdList: listHostIdListbody,
		AgentIdList: listAgentIdListbody,
		BackupProtectionStatus: "closed",
		CreateProtectionPolicy: createProtectionPolicybody,
		ProtectionPolicyId: &protectionPolicyIdProtectionInfoRequestInfo,
		RansomProtectionStatus: "opened",
		OperatingSystem: "Linux",
	}
	response, err := client.StartProtection(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

Proteção contra ransomware ativada.

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Prevenção contra ransomware