Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Host Security Service/ Referencia de la API/ Descripción de la API/ Prevención de ransomware/ Consulta de la lista de políticas de protección contra Ransomware
Actualización más reciente 2025-04-08 GMT+08:00

Consulta de la lista de políticas de protección contra Ransomware

Función

Esta API se utiliza para consultar la lista de políticas de protección contra ransomware.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

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

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID de proyecto

Mínimo: 1

Máximo: 256

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

enterprise_project_id

No

String

ID de proyecto empresarial. Para consultar todos los proyectos empresariales, establezca este parámetro en all_granted_eps.

Valor predeterminado: 0

Mínimo: 1

Máximo: 256

offset

No

Integer

Desfase, que especifica la posición inicial del registro que se va a devolver. El valor debe ser un número no menor que 0. El valor predeterminado es 0.

Mínimo: 0

Máximo: 2000000

Valor predeterminado: 0

limit

No

Integer

Número de registros mostrados en cada página.

Mínimo: 10

Máximo: 200

Valor predeterminado: 10

policy_name

No

String

Nombre de política

Mínimo: 0

Máximo: 128

protect_policy_id

No

String

ID de política

Mínimo: 0

Máximo: 128

operating_system

No

String

Sistemas operativos admitidos por la política. Las opciones son las siguientes:

  • Windows

  • Linux

Mínimo: 0

Máximo: 128

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token.

Mínimo: 1

Máximo: 32768

region

String

ID de región

Mínimo: 0

Máximo: 128

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

total_num

Integer

Número total de políticas

Mínimo: 0

Máximo: 2097152

data_list

Array of ProtectionPolicyInfo objects

Consultar la lista de políticas.

Longitud de la matriz: 0 - 10241

Tabla 5 ProtectionPolicyInfo

Parámetro

Tipo

Descripción

policy_id

String

ID de política

Mínimo: 0

Máximo: 128

policy_name

String

Nombre de política

Mínimo: 0

Máximo: 128

protection_mode

String

Acción. Su valor puede ser:

  • alarm_and_isolation: reportar una alarma y aislar.

  • alarm_only: solo reportar alarmas.

Mínimo: 0

Máximo: 128

bait_protection_status

String

Si se debe habilitar la protección honeypot. De forma predeterminada, la protección está habilitada. Su valor puede ser:

  • opened

  • closed

Mínimo: 0

Máximo: 128

deploy_mode

String

Si se debe habilitar la protección honeypot. Las opciones son las siguientes. De forma predeterminada, la protección dinámica de honeypot está deshabilitada.

  • opened

  • closed

Mínimo: 0

Máximo: 128

protection_directory

String

Directorio protegido

Mínimo: 1

Máximo: 128

protection_type

String

Tipo de archivo protegido, por ejemplo, .docx, .txt, y .avi.

Mínimo: 0

Máximo: 128

exclude_directory

String

Directorio excluido (opcional)

Mínimo: 1

Máximo: 128

runtime_detection_status

String

Si se deben realizar verificaciones en tiempo de ejecución. Las opciones son las siguientes. Actualmente, solo se puede deshabilitar. Este campo está reservado.

  • opened

  • closed

Mínimo: 0

Máximo: 128

runtime_detection_directory

String

Directorio a verificar durante la ejecución. Este campo está reservado.

Mínimo: 1

Máximo: 128

count_associated_server

Integer

Cantidad de servidores asociados

Mínimo: 0

Máximo: 2097152

operating_system

String

Tipo de sistema operativo.

  • Linux

  • Windows

Mínimo: 0

Máximo: 128

process_whitelist

Array of TrustProcessInfo objects

Lista blanca de procesos

Longitud de matriz: 0 - 20

default_policy

Integer

Indica si la política es la predeterminada. Las opciones son las siguientes:

  • 0: política no predeterminada

  • 1: política predeterminada

Mínimo: 0

Máximo: 10

Tabla 6 TrustProcessInfo

Parámetro

Tipo

Descripción

path

String

Indica la ruta del proceso.

Mínimo: 0

Máximo: 128

hash

String

Proceso hash

Mínimo: 0

Máximo: 128

Solicitudes de ejemplo

Consulte la lista de políticas de protección contra ransomware. Si no se especifica límite, se devuelven 10 registros de forma predeterminada.

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

Ejemplo de respuestas

Código de estado: 200

Lista de políticas de protección

{
  "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 ejemplo del SDK

El código de ejemplo del SDK es el siguiente.

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)
    }
}

Más información

Para obtener un código de ejemplo del SDK de más lenguajes de programación, consulte la pestaña Código de ejemplo en API Explorer. El código de ejemplo del SDK se puede generar automáticamente.

Códigos de estado

Código de estado

Descripción

200

Lista de políticas de protección

Códigos de error

Consulte Códigos de error.