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

Consulta as configurações de backup de uma instância do ApsaraDB RDS.

Descrição da operação

Mecanismos suportados

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

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

rds:DescribeBackupPolicy

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Você pode chamar DescribeDBInstances para obter o ID da instância.	rm-uf6wjk5****
BackupPolicyMode	string	Não	O tipo de backup. Valores válidos: DataBackupPolicy: backup de dados LogBackupPolicy: backup de logs.	DataBackupPolicy
CompressType	string	Não	O método de compressão de backup. Valores válidos: 0: não compactado 1: compressão zlib 2: compressão zlib paralela 4: compressão quicklz com restauração de banco de dados e tabelas ativada 8: compressão quicklz sem suporte à restauração de banco de dados e tabelas.	1
ReleasedKeepPolicy	string	Não	A política de retenção de dados de backup arquivados para instâncias MySQL excluídas. Valores válidos: None: Nenhum backup arquivado é retido. Lastest: Apenas o último backup arquivado é retido. All: Todos os backups arquivados são retidos.	Lastest

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
ArchiveBackupKeepCount	string	O número de backups arquivados retidos para a instância MySQL.	1
ArchiveBackupKeepPolicy	string	O ciclo de retenção de backups arquivados para a instância MySQL.	ByMonth
ArchiveBackupRetentionPeriod	string	O número de dias durante os quais os backups arquivados são retidos para a instância MySQL.	365
BackupInterval	string	O intervalo de backup. Unidade: minutos. Para instâncias MySQL: especifica a frequência de backup de snapshot (não o ciclo de backup de snapshot). Para instâncias SQL Server: especifica a frequência de backup de logs.	30
BackupLog	string	Indica se o backup de logs está ativado. Valores válidos: Enable: ativado Disabled: desativado Para instâncias SQL Server: Este parâmetro retorna Enable apenas quando a frequência de backup de logs da instância é a cada 5 minutos. Quando a frequência de backup de logs da instância é a cada 30 minutos ou consistente com o backup de dados, este parâmetro retorna Disabled. Use o valor de BackupInterval como referência.	Enable
BackupMethod	string	O método de backup para instâncias SQL Server com discos em nuvem. Valores válidos: Physical: backup físico Snapshot: backup de snapshot.	Physical
BackupPriority	integer	As configurações de backup para a instância secundária de uma instância SQL Server Enterprise Cluster Edition. Valores válidos: 1: Instância secundária preferida 2: Instância primária forçada Nota Este parâmetro é retornado apenas quando SupportModifyBackupPriority é True.	2
BackupRetentionPeriod	integer	O número de dias durante os quais os backups de dados são retidos.	7
Category	string	Indica se o backup em segundos está ativado para instâncias MySQL e PostgreSQL. Valores válidos: Flash: ativado Standard: desativado Nota Este parâmetro entra em vigor apenas quando o parâmetro BackupPolicyMode está definido como DataBackupPolicy.	Standard
CompressType	string	O método de compressão de backup. Valores válidos: 0: não compactado 1: compressão zlib 2: compressão zlib paralela 4: compressão quicklz com restauração de banco de dados e tabelas ativada 8: compressão quicklz sem suporte à restauração de banco de dados e tabelas.	1
EnableBackupLog	string	Indica se o backup de logs está ativado. Valores válidos: 1: ativado 0: desativado Para instâncias SQL Server: Este parâmetro retorna 1 apenas quando a frequência de backup de logs da instância é a cada 5 minutos. Quando a frequência de backup de logs da instância é a cada 30 minutos ou consistente com o backup de dados, este parâmetro retorna 0. Use o valor de BackupInterval como referência.	1
EnableIncrementDataBackup	boolean	Indica se o backup incremental está ativado para a instância SQL Server. Valores válidos: True: ativado False: desativado.	True
IncBackupInterval	integer
EnablePitrProtection	boolean	Indica se a recuperação point-in-time (PITR) está ativada para a instância MySQL (uma versão atualizada do backup de logs). Valores válidos: True: ativado False: desativado Nota Para mais informações, consulte Configurar uma política de recuperação point-in-time.	True
HighSpaceUsageProtection	string	Indica se os logs binários são excluídos à força quando o uso de armazenamento da instância MySQL excede 80% ou o armazenamento restante é inferior a 5 GB. Valores válidos: Disable: Os logs binários não são excluídos. Enable: Os logs binários são excluídos.	Enable
LocalLogRetentionHours	integer	O número de horas durante as quais os backups de logs binários são retidos localmente para a instância MySQL.	0
LocalLogRetentionSpace	string	A porcentagem máxima de armazenamento local que os backups de logs binários podem ocupar para a instância MySQL.	30
LogBackupFrequency	string	A frequência de backup de logs para a instância SQL Server. Valores válidos: LogInterval: a cada 30 minutos. Default: consistente com o ciclo de backup de dados PreferredBackupPeriod.	LogInterval
LogBackupLocalRetentionNumber	integer	O número de arquivos de log binário locais retidos para a instância MySQL.	60
LogBackupRetentionPeriod	integer	O número de dias durante os quais os backups de logs são retidos.	7
PitrRetentionPeriod	integer	O número de dias durante os quais a recuperação point-in-time é suportada para a instância MySQL.	7
PreferredBackupPeriod	string	O ciclo de backup de dados. Vários valores são separados por vírgulas (,). Valores válidos: Monday: Segunda-feira Tuesday: Terça-feira Wednesday: Quarta-feira Thursday: Quinta-feira Friday: Sexta-feira Saturday: Sábado Sunday: Domingo.	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	A hora do backup de dados. Formato: HH:mmZ-HH:mmZ (UTC).	15:00Z-16:00Z
PreferredNextBackupTime	string	A hora do próximo backup. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2018-01-19T15:15Z
ReleasedKeepPolicy	string	A política de retenção de dados de backup arquivados para instâncias MySQL excluídas. Valores válidos: None: Nenhum backup arquivado é retido. Lastest: Apenas o último backup arquivado é retido. All: Todos os backups arquivados são retidos.	None
RequestId	string	O ID da solicitação.	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	Indica se a instância SQL Server suporta a modificação da opção de backup da instância secundária. Valores válidos: True: suportado False: não suportado.	False
SupportReleasedKeep	integer	Um parâmetro reservado.	0
SupportVolumeShadowCopy	integer	Indica se a instância SQL Server suporta backup de snapshot. Valores válidos: 1: suportado 0: não suportado.	1
SupportsHighFrequencyBackup	integer	Indica se a instância SQL Server suporta o recurso de backup de logs de 5 minutos. Valores válidos: 0: não suportado 1: suportado.	0
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>
	object
StrategyId	string
ActionType	string
OnlyPreserveOneEachHour	boolean
RetentionValue	integer
BakType	string
FilterKey	string
FilterValue	string
DestType	string
FilterType	string
SrcRegion	string
OnlyPreserveOneEachDay	boolean
SrcType	string
DestRegion	string
RetentionType	string
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>
	object
StrategyId	string
ActionType	string
LogRetentionType	string
DestType	string
EnableLogBackup	integer
SrcType	string
SrcRegion	string
LogRetentionValue	integer
DestRegion	string
FilterKey	string
FilterValue	string
AdvancedBackupPolicyEnabled	boolean

Exemplos

Resposta de sucesso

JSON formato

{
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 0,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "LogRetentionType": "",
        "DestType": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "SrcRegion": "",
        "LogRetentionValue": 0,
        "DestRegion": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	IO.Exception	IO exception, retry later.
400	InternalFailure	Internal failure, retry later.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.