DescribeBackupPolicy - PolarDB: Central de Documentação do Alibaba Cloud

Consulta a política de backup automático de um cluster PolarDB.

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

polardb:DescribeBackupPolicy

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster. Nota Chame a operação DescribeDBClusters para consultar os detalhes de todos os clusters em uma região, incluindo os IDs dos clusters.	pc-*************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PreferredBackupPeriod	string	O ciclo de backup. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
DataLevel1BackupRetentionPeriod	string	O período de retenção de backups de nível 1. Valores válidos: 3 a 14. Unidade: dias. Nota Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	7
RequestId	string	O ID da solicitação.	EADFCE0F-9FB5-4685-B395-1440B******
PreferredBackupTime	string	O intervalo de tempo em que um backup automático é realizado. O horário está no formato `HH:mmZ-HH:mmZ`. O horário é exibido em UTC.	07:00Z-08:00Z
BackupRetentionPolicyOnClusterDeletion	string	A política de retenção de backups ao excluir um cluster: ALL: Retém todos os backups permanentemente. LATEST: Retém o último backup permanentemente. NONE (Padrão): Não retém conjuntos de backup.	NONE
PreferredNextBackupTime	string	O horário do próximo backup. O horário está no formato `YYYY-MM-DDThh:mmZ`. O horário é exibido em UTC.	2020-11-16T07:30Z
DataLevel2BackupRetentionPeriod	string	O período de retenção de backups de nível 2. Valores válidos: 0: O recurso de backup de nível 2 está desativado. 30 a 7300: O período de retenção de backups de nível 2 em dias. -1: Os backups de nível 2 são retidos permanentemente. Nota Ao criar um cluster, o valor padrão é 0. Isso significa que o recurso de backup de nível 2 está desativado. Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	0
BackupFrequency	string	A frequência de backup. Valores válidos: Normal (Padrão): Backup padrão. Um backup é realizado uma vez por dia. 2/24H: Backup aprimorado. Um backup é realizado a cada 2 horas. 3/24H: Backup aprimorado. Um backup é realizado a cada 3 horas. 4/24H: Backup aprimorado. Um backup é realizado a cada 4 horas. Nota Se você ativar o backup aprimorado, todos os backups concluídos dentro de 24 horas serão retidos. Para backups concluídos há mais de 24 horas, o sistema retém apenas o primeiro backup concluído após 00:00 de cada dia. Os outros backups são excluídos. Se você ativar o backup aprimorado, o parâmetro PreferredBackupPeriod será automaticamente definido para todos os dias da semana (segunda a domingo).	Normal
DataLevel1BackupFrequency	string	A frequência de backup. Valores válidos: Normal (Padrão): Backup padrão. Um backup é realizado uma vez por dia. 2/24H: Backup de alta frequência. Um backup é realizado a cada 2 horas. 3/24H: Backup de alta frequência. Um backup é realizado a cada 3 horas. 4/24H: Backup de alta frequência. Um backup é realizado a cada 4 horas. Nota Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL. Este parâmetro não é compatível se o recurso de backup entre regiões não estiver disponível na região onde seu cluster PolarDB for MySQL reside. Para mais informações sobre as regiões que suportam backup entre regiões, consulte Visão geral. Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	Normal
DataLevel1BackupPeriod	string	O ciclo de um backup de nível 1. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Selecione pelo menos dois dias. Separe múltiplos valores com vírgulas (,). Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL. Este parâmetro não é compatível se o recurso de backup entre regiões não estiver disponível na região onde seu cluster PolarDB for MySQL reside. Para mais informações sobre as regiões que suportam backup entre regiões, consulte Visão geral. Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	Monday,Tuesday
DataLevel1BackupTime	string	O intervalo de tempo em que um backup automático é realizado. O horário está no formato `hh:mmZ-hh:mmZ` e é exibido em UTC. O intervalo de tempo especificado deve ser de 1 hora em ponto, como `14:00Z-15:00Z`. Nota Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL. Este parâmetro não é compatível se o recurso de backup entre regiões não estiver disponível na região onde seu cluster PolarDB for MySQL reside. Para mais informações sobre as regiões que suportam backup entre regiões, consulte Visão geral.	15:00Z-16:00Z
DataLevel2BackupPeriod	string	O ciclo de um backup de nível 2. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Selecione pelo menos dois dias. Separe múltiplos valores com vírgulas (,). Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL. Este parâmetro não é compatível se o recurso de backup entre regiões não estiver disponível na região onde seu cluster PolarDB for MySQL reside. Para mais informações sobre as regiões que suportam backup entre regiões, consulte Visão geral. Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	Monday,Tuesday
DataLevel2BackupAnotherRegionRetentionPeriod	string	O período de retenção de backups de nível 2 entre regiões. Valores válidos: 0: O recurso de backup de nível 2 está desativado. 30 a 7300: O período de retenção de backups de nível 2 em dias. -1: Os backups de nível 2 são retidos permanentemente. Nota Ao criar um cluster, o valor padrão é 0. Isso significa que o recurso de backup entre regiões para backups de nível 2 está desativado. Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	30
DataLevel2BackupAnotherRegionRegion	string	A região de destino do backup de nível 2 entre regiões. Para mais informações sobre as regiões que suportam backup entre regiões, consulte Visão geral. Nota Este parâmetro não é recomendado se o recurso de backup avançado estiver ativado. Use o parâmetro AdvancedDataPolicies em vez disso.	cn-hangzhou
BackupPolicyLevel	string	O nível da política de backup. Valores válidos: Normal: backup padrão Advanced: backup avançado Nota Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL.	Normal
AdvancedPolicyOption	string	A opção de política de backup avançado. Valores válidos: enable: O backup avançado está ativado. disable: O backup avançado está desativado. Você pode ativá-lo. notSupport: O backup avançado não é compatível. Nota Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL.	disable
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>	Os detalhes da política de backup avançado. Nota Este parâmetro não é compatível com PolarDB for PostgreSQL (compatível com Oracle) e PolarDB for PostgreSQL.
	object
PolicyId	string	The ID of the backup policy.	71930ac2e9f15e41615e10627c******
RetentionType	string	The retention period type of the backup set. The return value is: never: permanent retention delay: retention for a specified number of days	delay
RetentionValue	string	The number of days to retain the backup.	7
FilterType	string	The filter type for the advanced policy. The return value is: crontab: recurring schedule event: event-triggered schedule	crontab
FilterKey	string	The scheduling type. The return value is: dayOfWeek: weekly schedule dayOfMonth: monthly schedule dayOfYear: yearly schedule backupInterval: fixed-interval schedule Nota This parameter is returned only when FilterType is set to crontab.	dayOfWeek
FilterValue	string	The backup cycle.	1,2,3,4,5,6,7
SrcType	string	The source type of the backup policy. The return value is: db: database cluster level1: level-1 backup level2: level-2 backup level2Cross: cross-region level-2 backup	level1
SrcRegion	string	The source region of the backup policy.	cn-beijing
DestType	string	The destination type of the backup policy. The return value is: level1: level-1 backup level2: level-2 backup level2Cross: cross-region level-2 backup	level1
DestRegion	string	The destination region of the backup policy.	cn-hangzhou
DumpAction	string	The method to convert a level-1 backup to a level-2 backup. The return value is: copy: copy	copy
AutoCreated	boolean	Indicates whether the backup policy is automatically generated by the system. The return value is: true: The policy is generated by the system. false: The policy is a custom policy.	true
OnlyPreserveOneEachHour	boolean	The hourly backup retention policy. Valid values: true: Retain only the earliest backup set that is created within the hour. false: Retain all backup sets.	true
OnlyPreserveOneEachDay	boolean	The 24-hour backup retention policy. true: Retain only the first backup set of the day if the backup set is created more than 24 hours ago. false: Retain all backup sets.	true
BakType	string	The backup type. The return value is: F: full backup	F
StorageClass	string

Exemplos

Resposta de sucesso

JSON formato

{
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "DataLevel1BackupRetentionPeriod": "7",
  "RequestId": "EADFCE0F-9FB5-4685-B395-1440B******",
  "PreferredBackupTime": "07:00Z-08:00Z",
  "BackupRetentionPolicyOnClusterDeletion": "NONE",
  "PreferredNextBackupTime": "2020-11-16T07:30Z",
  "DataLevel2BackupRetentionPeriod": "0",
  "BackupFrequency": "Normal",
  "DataLevel1BackupFrequency": "Normal",
  "DataLevel1BackupPeriod": "Monday,Tuesday",
  "DataLevel1BackupTime": "15:00Z-16:00Z",
  "DataLevel2BackupPeriod": "Monday,Tuesday",
  "DataLevel2BackupAnotherRegionRetentionPeriod": "30",
  "DataLevel2BackupAnotherRegionRegion": "cn-hangzhou",
  "BackupPolicyLevel": "Normal",
  "AdvancedPolicyOption": "disable",
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "PolicyId": "71930ac2e9f15e41615e10627c******\n",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "SrcType": "level1",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-hangzhou",
        "DumpAction": "copy",
        "AutoCreated": true,
        "OnlyPreserveOneEachHour": true,
        "OnlyPreserveOneEachDay": true,
        "BakType": "F",
        "StorageClass": ""
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.