Todos os produtos
Search
Central de documentação

Cloud Backup:CreatePolicyV2

Última atualização: Oct 29, 2026

Cria uma política.

Descrição da operação

Uma política de backup registra as informações necessárias para os backups. Após a execução de uma política de backup, um job de backup é gerado para registrar o progresso e os resultados do backup. Se o job de backup for bem-sucedido, um snapshot de backup será gerado. Você pode usar o snapshot de backup para criar um job de restauração.

  • Uma política de backup suporta várias fontes de dados, incluindo backup de NAS, backup de OSS, backup de instância ECS, ECS File Backup Standard Edition, backup de arquivo local, backup de Tablestore e backup de CPFS.

  • Uma política de backup suporta apenas uma única política de ciclo de backup com um intervalo de tempo fixo.

  • Uma política de backup pode fazer backup de dados em apenas um cofre de backup.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hbr:CreatePolicyV2

create

*Todos os recursos.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

PolicyName

string

Não

O nome da política.

Daily local backup + cross-region backup

PolicyType

string

Não

O tipo de política. Valores válidos:

  • STANDARD: política de backup geral. Suporta o backup de fontes de dados diferentes de instâncias ECS.

  • UDM_ECS_ONLY: política de backup de instância ECS. Suporta apenas o backup de instâncias ECS.

Se você não especificar o tipo de política, o Cloud Backup definirá automaticamente o tipo de política com base na especificação de um cofre de backup nas regras da política:

  • Se um cofre de backup for especificado nas regras da política: STANDARD.

  • Se nenhum cofre de backup for especificado nas regras da política: UDM_ECS_ONLY.

STANDARD

PolicyDescription

string

Não

A descrição da política.

Back up data at 10:00 AM every day and perform a cross-region backup to Shanghai.

Rules

array<object>

Não

A lista de regras da política.

array<object>

Não

A regra da política.

RuleType

string

Sim

O tipo de regra. Cada política deve conter pelo menos uma regra BACKUP e exatamente uma regra TRANSITION. Valores válidos:

  • BACKUP: regra de backup.

  • TRANSITION: regra de ciclo de vida.

  • REPLICATION: regra de replicação.

  • TAG: regra de associação de recursos baseada em tags.

Valores válidos:

  • TRANSITION :

    Regra de ciclo de vida.

  • BACKUP :

    Regra de backup.

  • REPLICATION :

    Regra de replicação.

  • SECURITY :

    Regra de segurança.

  • TAG :

    Regra de associação de recursos baseada em tags.

BACKUP

Schedule

string

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP. O agendamento de backup. Formatos válidos:

  • I|{startTime}|{interval}: executa um job de backup em um intervalo de {interval} a partir de {startTime}. Por exemplo, I|1631685600|P1D indica que um job de backup é executado todos os dias a partir das 14:00:00 de 15 de setembro de 2021.

    • startTime: a hora de início do backup. O valor é um carimbo de data/hora UNIX em segundos.

    • interval: o intervalo de tempo ISO 8601. Por exemplo, PT1H indica um intervalo de uma hora e P1D indica um intervalo de um dia.

  • C|{startTime}|{crontab}: executa um job de backup com base na expressão {crontab} a partir de {startTime}. Por exemplo, C|1631685600|0 0 2 ? * 3,5,7 indica que um job de backup é executado às 02:00:00 de todas as terças, quintas e sábados a partir das 14:00:00 de 15 de setembro de 2021.

    • startTime: a hora de início do backup. O valor é um carimbo de data/hora UNIX em segundos.

    • crontab: a expressão crontab. Por exemplo, 0 0 2 ? * 3,5,7 indica 02:00:00 de todas as terças, quintas e sábados.

Os jobs de backup que perderam o horário agendado não são compensados. Se o job de backup anterior não for concluído, o próximo job de backup não será acionado.

I|1648647166|P1D

BackupType

string

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP. O tipo de backup. O valor COMPLETE indica um backup completo.

Valores válidos:

  • ARCHIVE_BY_SEARCH :

    Arquivamento por resultado de pesquisa.

  • COMPLETE :

    Backup completo.

  • LOG :

    Backup de log.

  • ARCHIVE :

    Arquivamento.

  • DIFFERENTIAL :

    Backup diferencial.

  • INDEX :

    Índice.

  • INCREMENTAL :

    Backup incremental.

COMPLETE

Retention

integer

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP, TRANSITION ou REPLICATION.

  • Se RuleType for definido como BACKUP: o período de retenção do backup. A prioridade deste parâmetro é menor que a do parâmetro Retention em uma regra onde RuleType é definido como TRANSITION. Valor mínimo: 1. Valor máximo: 364635. Unidade: dias.

  • Se RuleType for definido como TRANSITION: o período de retenção do backup. Valor mínimo: 1. Valor máximo: 364635. Unidade: dias.

  • Se RuleType for definido como REPLICATION: o período de retenção do backup entre regiões. Valor mínimo: 1. Valor máximo: 364635. Unidade: dias.

7

ReplicationRegionId

string

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como REPLICATION. O ID da região de destino para replicação.

cn-shanghai

ArchiveDays

integer

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como TRANSITION. O número de dias após o qual um backup é automaticamente transferido para a camada de arquivamento. Os backups devem ser retidos na camada padrão por pelo menos 30 dias e na camada de arquivamento por pelo menos 60 dias após a transição. Unidade: dias.

90

RetentionRules

array<object>

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como TRANSITION. As regras especiais de retenção.

object

Não

A regra especial de retenção.

AdvancedRetentionType

string

Não

O tipo da regra especial de retenção. Valores válidos:

  • DAILY: backup diário.

  • WEEKLY: backup semanal.

  • MONTHLY: backup mensal.

  • YEARLY: backup anual.

YEARLY

WhichSnapshot

integer

Não

O número de sequência do backup ao qual a regra se aplica. Atualmente, apenas o primeiro backup é suportado. Defina o valor como 1.

1

Retention

integer

Não

O período especial de retenção do backup. Valor mínimo: 1. Unidade: dias.

730

VaultId

string

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como BACKUP. O ID do cofre de backup.

v-0001************aseg

KeepLatestSnapshots

integer

Não

Especifica se deve ser retida pelo menos uma versão de backup. Valores válidos:

  • 0: Não reter.

  • 1: Reter.

1

Immutable

boolean

Não

Este parâmetro é obrigatório apenas quando PolicyType é definido como UDM_ECS_ONLY e RuleType é definido como SECURITY. Especifica se o bloqueio de backup deve ser ativado.

true

DataSourceFilters

array<object>

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como TAG. As regras de filtragem de fonte de dados.

array<object>

Não

SourceType

string

Não

O tipo de fonte de dados. Valores válidos:

  • UDM_ECS: backup de instância ECS. Este tipo de fonte de dados é suportado apenas quando PolicyType é definido como UDM_ECS_ONLY.

  • OSS: backup de OSS. Este tipo de fonte de dados é suportado apenas quando PolicyType é definido como STANDARD.

  • NAS: backup do Alibaba Cloud NAS. Este tipo de fonte de dados é suportado apenas quando PolicyType é definido como STANDARD.

  • ECS_FILE: ECS File Backup Standard Edition. Este tipo de fonte de dados é suportado apenas quando PolicyType é definido como STANDARD.

  • OTS: backup de Tablestore. Este tipo de fonte de dados é suportado apenas quando PolicyType é definido como STANDARD.

UDM_ECS

DataSourceIds deprecated

array

Não

[Descontinuado]

deprecated

string

Não

[Descontinuado]

**[Deprecated]**

AccountScope

string

Não

O escopo da conta ao qual a política se aplica.

SPECIFIED_ACCOUNT

Accounts

array<object>

Não

A lista de informações da conta nas condições de filtragem da fonte de dados.

object

Não

CrossAccountType

string

Não

O tipo de associação de conta, que é usado para distinguir entre a conta atual e cenários de contas cruzadas.

CROSS_ACCOUNT_BY_RD

CrossAccountUserId

integer

Não

O ID da conta Alibaba Cloud da conta que possui os recursos a serem submetidos a backup.

1234567890123456

CrossAccountRoleName

string

Não

O nome da função RAM criada na conta que possui os recursos a serem submetidos a backup.

hbrcrossrole

TagFilters

array<object>

Não

Este parâmetro é obrigatório apenas quando RuleType é definido como TAG. As regras de filtragem de tags de recursos.

object

Não

Key

string

Não

A chave da tag.

env

Value

string

Não

O valor da tag. Um valor vazio indica qualquer valor.

prod

Operator

string

Não

A regra de correspondência de tags. Valores válidos:

  • EQUAL: corresponde tanto à chave da tag quanto ao valor da tag.

  • NOT: corresponde à chave da tag, mas não ao valor da tag.

EQUAL

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

CreatePolicyResponse.

Success

boolean

Indica se a solicitação foi bem-sucedida. Valores válidos:

  • true: A solicitação foi bem-sucedida.

  • false: A solicitação falhou.

true

Code

string

O código de retorno. O valor 200 indica sucesso.

200

Message

string

A mensagem de retorno. Se a solicitação for bem-sucedida, "successful" será retornado. Se ocorrer um erro, a mensagem de erro correspondente será retornada.

successful

RequestId

string

O ID da solicitação.

EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F

PolicyId

string

O ID da política.

po-000000zemnuyx2li3y9y

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F",
  "PolicyId": "po-000000zemnuyx2li3y9y"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.