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> Cloud Backup and Recovery> Referência de API> APIs do CBR> Políticas> Criação de uma política

Atualizado em 2023-04-26 GMT+08:00

Ver PDF

Criação de uma política

Função

Esta API é usada para criar uma política. As políticas são classificadas em políticas de backup e políticas de replicação.

URI

POST /v3/{project_id}/policies

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto

Parâmetros de solicitação

**Tabela 2** Parâmetros do cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token de usuário. O token 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 é o token do usuário.

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
Política	Sim	PolicyCreate object	Corpo da solicitação para criar uma política

**Tabela 4** PolicyCreate
Parâmetro	Obrigatório	Tipo	Descrição
Habilitado	Não	Boolean	Se habilitar a política Padrão: true
name	Sim	String	Especifica o nome da política. O valor consiste de 1 a 64 caracteres e pode conter apenas letras, dígitos, sublinhados (_) e hifens (-). Mínimo: 1 Máximo: 64
operation_definition	Sim	PolicyoODCreate object	Parâmetro de agendamento
operation_type	Sim	String	Tipo de proteção, que pode ser backup ou replication
trigger	Sim	PolicyTriggerReq object	Regra de tempo para a execução da política

**Tabela 5** PolicyoODCreate
Parâmetro	Obrigatório	Tipo	Descrição
day_backups	Não	Integer	Especifica o número de backups diários retidos. O último backup de cada dia é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100
destination_project_id	Não	String	ID do projeto de destino de replicação, que é obrigatório para a replicação entre regiões
destination_region	Não	String	ID da região de destino da replicação, que é obrigatório para a replicação entre regiões. O valor consiste de 0 a 255 caracteres e pode conter apenas letras, dígitos, sublinhado (_) e hifens (-).
enable_acceleration	Não	Boolean	Se ativar a função de aceleração para encurtar o tempo de replicação para replicação entre regiões. Se este parâmetro não estiver definido, a função de aceleração é desativada.
max_backups	Não	Integer	Número máximo de backups retidos. 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 a quantidade de backup retida configurada seja excedida. Se esse parâmetro e a retention_duration_days forem deixados em branco, os backups serão mantidos permanentemente. Mínimo: 1 Máximo: 99999 Padrão: -1
month_backups	Não	Integer	Especifica o número de backups mensais retidos. O último backup de cada mês é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. 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. -1 indica que os backups não serão limpos com base na duração da retenção. Se este parâmetro e max_backups forem deixados em branco ao mesmo tempo, os backups serão mantidos permanentemente. Mínimo: 1 Máximo: 99999 Padrão: -1
timezone	Não	String	Fuso horário em que o usuário está localizado, por exemplo, UTC+08:00. Defina este parâmetro se tiver configurado algum dos parâmetros: day_backups, week_backups, month_backups, year_backups.
week_backups	Não	Integer	Especifica o número 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 especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório.
year_backups	Não	Integer	Especifica o número 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 especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100

**Tabela 6** PolicyTriggerReq
Parâmetro	Obrigatório	Tipo	Descrição
properties	Sim	PolicyTriggerPropertiesReq object	Atributos do agendador

**Tabela 7** PolicyTriggerPropertiesReq
Parâmetro	Obrigatório	Tipo	Descrição
pattern	Sim	Array of strings	Regra de programação do agendador. Um máximo de 24 regras podem ser configuradas. A regra de agendamento está em conformidade com o iCalendar RFC 2445, mas suporta apenas os parâmetros FREQ, BYDAY, BYHOUR, BYMINUTE e INTERVAL. FREQ pode ser definido apenas para WEEKLY ou DAILY. BYDAY pode ser definido como MO, TU, WE, TH, FR, SA e SU (sete dias por semana). BYHOUR varia de 0 a 23 horas. BYMINUTE varia de 0 a 59 minutos. O intervalo de agendamento não pode 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 (UTC) 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. Se o horário de agendamento for 14:00 (UTC+8) todos os dias, defina a regra de agendamento da seguinte forma: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

Parâmetros de resposta

Código de status: 200

**Tabela 8** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
policy	Policy object	Resposta ao pedido de criação de uma política

**Tabela 9** Política
Parâmetro	Tipo	Descrição
enabled	Boolean	Se a política está habilitada
id	String	ID da política
name	String	Nome da política
operation_definition	PolicyoODCreate object	Atributos da política
operation_type	String	Tipo de proteção, que pode ser backup ou replication Valores de enumeração: backup
trigger	PolicyTriggerResp object	Regra de programação de tempo para a política
associated_vaults	Array of PolicyAssociateVault objects	Cofre associado

**Tabela 10** PolicyoODCreate
Parâmetro	Tipo	Descrição
day_backups	Integer	Especifica o número de backups diários retidos. O último backup de cada dia é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100
destination_project_id	String	ID do projeto de destino de replicação, que é obrigatório para a replicação entre regiões
destination_region	String	ID da região de destino da replicação, que é obrigatório para a replicação entre regiões. O valor consiste de 0 a 255 caracteres e pode conter apenas letras, dígitos, sublinhado (_) e hifens (-).
enable_acceleration	Boolean	Se ativar a função de aceleração para encurtar o tempo de replicação para replicação entre regiões. Se este parâmetro não estiver definido, a função de aceleração é desativada.
max_backups	Integer	Número máximo de backups retidos. 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 a quantidade de backup retida configurada seja excedida. Se esse parâmetro e a retention_duration_days forem deixados em branco, os backups serão mantidos permanentemente. Mínimo: 1 Máximo: 99999 Padrão: -1
month_backups	Integer	Especifica o número de backups mensais retidos. O último backup de cada mês é salvo a longo prazo. Este parâmetro pode ser efetivo junto com o número máximo de backups retidos especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. 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. -1 indica que os backups não serão limpos com base na duração da retenção. Se este parâmetro e max_backups forem deixados em branco ao mesmo tempo, os backups serão mantidos permanentemente. Mínimo: 1 Máximo: 99999 Padrão: -1
timezone	String	Fuso horário em que o usuário está localizado, por exemplo, UTC+08:00. Defina este parâmetro se tiver configurado algum dos parâmetros: day_backups, week_backups, month_backups, year_backups.
week_backups	Inteiro	Especifica o número 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 especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório.
year_backups	Integer	Especifica o número 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 especificados por max_backups. O valor varia de 0 a 100. Se este parâmetro estiver configurado, timezone é obrigatório. Mínimo: 0 Máximo: 100

**Tabela 11** PolicyTriggerResp
Parâmetro	Tipo	Descrição
id	String	ID do agendador
name	String	Nome do agendador
properties	PolicyTriggerPropertiesResp object	Atributos do agendador
type	String	Tipo de agendador. Atualmente, apenas time (agendamento periódico) é suportado. Valores de enumeração: time

**Tabela 12** PolicyTriggerPropertiesResp
Parâmetro	Tipo	Descrição
pattern	Array of strings	Regra de programação do agendador. Um máximo de 24 regras podem ser configuradas. A regra de agendamento está em conformidade com o iCalendar RFC 2445, mas suporta apenas os parâmetros FREQ, BYDAY, BYHOUR, BYMINUTE e INTERVAL. FREQ pode ser definido apenas para WEEKLY ou DAILY. BYDAY pode ser definido como MO, TU, WE, TH, FR, SA e SU (sete dias por semana). BYHOUR varia de 0 a 23 horas. BYMINUTE varia de 0 a 59 minutos. O intervalo de agendamento não pode 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 (UTC) 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. Se o horário de agendamento for 14:00 (UTC+8) todos os dias, defina a regra de agendamento da seguinte forma: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00
start_time	String	Hora de início do agendador, por exemplo, 2020-01-08 09:59:49

**Tabela 13** PolicyAssociateVault
Parâmetro	Tipo	Descrição
destination_vault_id	String	ID do cofre remoto associado
vault_id	String	ID do cofre

Exemplo de solicitações

POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies

{
  "policy" : {
    "enabled" : true,
    "name" : "policy001",
    "operation_definition" : {
      "day_backups" : 0,
      "month_backups" : 0,
      "retention_duration_days" : 1,
      "timezone" : "UTC+08:00",
      "week_backups" : 0,
      "year_backups" : 0
    },
    "operation_type" : "backup",
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
      }
    }
  }
}

Exemplo de respostas

Código de status: 200

{
  "policy" : {
    "name" : "policy001",
    "associated_vaults" : null,
    "enabled" : true,
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
        "start_time" : "2019-05-08 06:57:05"
      },
      "type" : "time",
      "id" : "d67269a6-5369-42d7-8150-5254bd446328",
      "name" : "default"
    },
    "operation_definition" : {
      "retention_duration_days" : 1,
      "year_backups" : 0,
      "day_backups" : 0,
      "month_backups" : 0,
      "week_backups" : 0,
      "timezone" : "UTC+08:00"
    },
    "operation_type" : "backup",
    "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
  }
}