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 política de backup vinculada ao cofre de proteção do HSS
Atualizado em 2024-09-14 GMT+08:00

Consulta da política de backup vinculada ao cofre de proteção do HSS

Função

Essa API é usada para consultar a política de backup vinculada ao cofre de proteção do HSS. Certifique-se de que um cofre de proteção contra ransomware tenha sido comprado no CBR. Esse cofre é nomeado no formato HSS_projectid.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

GET /v5/{project_id}/backup/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

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

enabled

Boolean

Se a política está ativada

id

String

ID da política

Mínimo: 1

Máximo: 128

name

String

Nome da política

Mínimo: 1

Máximo: 128

operation_type

String

Tipo de backup. Seu valor pode ser:

  • backup

  • replication

Mínimo: 1

Máximo: 128

operation_definition

OperationDefinitionInfo object

Atributo de política. Regra reservada.

trigger

BackupTriggerInfo object

Regra de agendamento da política de backup

Tabela 5 OperationDefinitionInfo

Parâmetro

Tipo

Descrição

day_backups

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

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

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 esse parâmetro for especificado, o fuso horário deverá ser configurado. Valor mínimo: 0. Valor máximo: 100

Mínimo: 0

Máximo: 100

retention_duration_days

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

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

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

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 6 BackupTriggerInfo

Parâmetro

Tipo

Descrição

id

String

ID do agendador

Mínimo: 0

Máximo: 256

name

String

Nome do agendador

Mínimo: 0

Máximo: 256

type

String

Tipo de agendador. Atualmente, apenas o tempo pode ser configurado.

Mínimo: 0

Máximo: 256

properties

BackupTriggerPropertiesInfo object

Atributo do agendador

Tabela 7 BackupTriggerPropertiesInfo

Parâmetro

Tipo

Descrição

pattern

Array of strings

Política de agendamento. O valor contém um máximo de 10.240 caracteres e está em conformidade com iCalendar RFC 2445. No entanto, apenas FREQ, BYDAY, BYHOUR e BYMINUTE são suportados. FREQ pode ser definido como apenas WEEKLY ou DAILY. BYDAY pode ser definido para os sete dias em uma semana (MO, TU, WE, TH, FR, SA e SU). BYHOUR pode ser definido de 0 a 23 horas. BYMINUTE pode ser definido de 0 a 59 minutos. O intervalo entre os pontos de tempo não pode ser inferior a uma hora. Vários pontos de tempo de backup podem ser definidos em uma política de backup e até 24 pontos de tempo podem ser definidos para um dia.

Mínimo: 0

Máximo: 256

Comprimento da matriz: 0–24

start_time

String

Hora de início do agendador. Exemplo: 2020-01-08 09:59:49

Mínimo: 0

Máximo: 256

Exemplo de solicitações

Essa API é usada para consultar a política de backup vinculada ao cofre.

GET https://{endpoint}/v5/{project_id}/backup/policy

Exemplo de respostas

Código de status: 200

Informações sobre a política de backup

{
  "enabled" : true,
  "id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
  "name" : "HSS_84b5266c14ae489fa6549827f032dc62",
  "operation_type" : "backup",
  "operation_definition" : {
    "day_backups" : 0,
    "max_backups" : "-1",
    "month_backups" : 0,
    "retention_duration_days" : 5,
    "timezone" : "UTC+08:00",
    "week_backups" : 0,
    "year_backups" : 0
  },
  "trigger" : {
    "properties" : {
      "pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
    }
  }
}

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

    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();
        ShowBackupPolicyInfoRequest request = new ShowBackupPolicyInfoRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        try {
            ShowBackupPolicyInfoResponse response = client.showBackupPolicyInfo(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
# 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 = ShowBackupPolicyInfoRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        response = client.show_backup_policy_info(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
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.ShowBackupPolicyInfoRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	response, err := client.ShowBackupPolicyInfo(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

Informações sobre a política de backup

Códigos de erro

Consulte Códigos de erro.