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

Cria um conjunto de backup para uma instância RDS.

Descrição da operação

Mecanismos suportados

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

Função

Esta API encapsula a API de backup integrada do RDS. Você também pode usar o DBS. Para mais informações, consulte a visão geral da API do DBS.

Pré-requisitos

A chamada de API falha a menos que a instância atenda às seguintes condições.

A instância está em execução.
Nenhuma tarefa de backup está em andamento.
Você pode criar no máximo 20 conjuntos de backup para uma instância por dia.

Documentação relacionada

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:CreateBackup

create

*DBInstance

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

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. Chame a operação DescribeDBInstances para obter este ID.	rm-uf6wjk5****
DBName	string	Não	Os nomes dos bancos de dados para fazer backup. Separe vários nomes de bancos de dados com uma vírgula (,). Nota Este parâmetro é aplicável apenas quando o parâmetro BackupStrategy está definido como db.	rds_mysql
BackupStrategy	string	Não	A estratégia de backup. Valores válidos: db: backup de banco de dados instance: backup de instância Nota Este parâmetro é aplicável apenas se uma das seguintes condições for atendida: Para uma instância MySQL, o parâmetro BackupMethod está definido como Logical. Para uma instância SQL Server, o parâmetro BackupType está definido como FullBackup.	db
BackupMethod	string	Não	O tipo de backup. Valores válidos: Logical: um backup lógico (suportado apenas para instâncias MySQL que usam discos locais). Physical: um backup físico (suportado para instâncias MySQL que usam discos locais, instâncias SQL Server e PostgreSQL). Snapshot: um snapshot (suportado para instâncias MySQL que usam discos em nuvem, instâncias SQL Server, PostgreSQL e MariaDB). Valor padrão: Physical. Nota Para um backup lógico, o banco de dados não deve estar vazio. As instâncias MariaDB suportam apenas snapshots. No entanto, você deve definir este parâmetro como Physical para instâncias MariaDB.	Physical
BackupType	string	Não	O tipo de backup para uma instância SQL Server. Valores válidos: Auto (Padrão): O sistema determina automaticamente se deve realizar um backup completo ou incremental. FullBackup: Um backup completo. Nota Este parâmetro é aplicável apenas quando o parâmetro BackupMethod está definido como Physical.	Auto
BackupRetentionPeriod	integer	Não	SQL Server: O número de dias para reter o conjunto de backup. Este parâmetro é válido apenas quando BackupStrategy está definido como db, BackupMethod está definido como Physical e BackupType está definido como FullBackup. Valores válidos: 7 a 730. Um valor de -1 especifica retenção de longo prazo. MySQL: O número de dias para reter o conjunto de backup. Valores válidos: 7 a 730. Um valor de -1 especifica retenção de longo prazo.	7

Parâmetros opcionais

Esta API aceita quatro parâmetros opcionais: BackupMethod, BackupStrategy, BackupType e DBName. A combinação de parâmetros necessária depende do mecanismo e do seu caso de uso.

MySQL

Para backups físicos e de snapshot, especifique apenas o parâmetro BackupMethod. Por padrão, todos os bancos de dados são submetidos a backup. Backups de banco de dados único não são suportados.
Para backups lógicos:
- Para fazer backup de um único banco de dados, especifique os parâmetros BackupMethod, BackupStrategy e DBName.
- Para fazer backup de uma instância completa, especifique os parâmetros BackupMethod e BackupStrategy.

SQL Server

Para backups de snapshot, especifique apenas o parâmetro BackupMethod. Por padrão, todos os bancos de dados são submetidos a backup. Backups de banco de dados único não são suportados.
Para backups físicos:
- Para um backup completo de um único banco de dados, especifique todos os quatro parâmetros opcionais: BackupMethod, BackupStrategy, BackupType e DBName.
- Para realizar um backup completo de toda a instância, especifique os parâmetros BackupMethod, BackupType e BackupStrategy.
- Para permitir que o sistema escolha automaticamente entre um backup completo ou incremental, especifique os parâmetros BackupMethod e BackupType.
Backups lógicos não são suportados.

PostgreSQL

Para backups físicos e de snapshot, especifique apenas o parâmetro BackupMethod. Por padrão, todos os bancos de dados são submetidos a backup. Backups de banco de dados único não são suportados.
Backups lógicos não são suportados.

MariaDB

Para backups de snapshot, especifique apenas o parâmetro BackupMethod. Por padrão, todos os bancos de dados são submetidos a backup. Backups de banco de dados único não são suportados.
Backups físicos e lógicos não são suportados.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
BackupJobId	string	O ID do trabalho de backup.	507****
RequestId	string	O ID da solicitação.	2C125605-266F-41CA-8AC5-3A643D4F42C5

Exemplos

Resposta de sucesso

JSON formato

{
  "BackupJobId": "507****",
  "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	BackupType.NotSupport	the specified backup type not support	This operation is not supported for the specified backup type.
400	InvalidBackupMethod.ValueNotSupport	The specified parameter "BackupMethod" is not valid.	The backup method is invalid. Specify a valid backup method. Valid values: Logical and Physical. Default value: Physical. Logical backups are not supported for RDS instances in which no databases are created, and physical backups are supported only for RDS instances that run SQL Server.
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.
400	IncorrectDBInstanceLockMode.ValueNotSupported	The Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
400	BackupJobExists	A backup job already exists in the specified DB instance.	The backup has been created.
400	InvalidPreferredBackupTime.Format	Specified preferred backup time is not valid.	The time of the backup file is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.
400	InvalidDBName.Format	Specified DB name is not valid.	The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	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.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
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.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.	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.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	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.	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.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	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.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	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.	The request failed to be processed due to an RDS API failure.
403	OperationDenied.ApiForbidden	operation not permitted.	The operation is not allowed.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.	The operation failed. The operation is not supported for the database engine of the RDS instance.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceCharacterType	Current DB Instance character_type does not support this operation.	This operation is not supported for the character type of the current instance.
403	Exceeded.BackupTimes	The backup times exceeds.	The specified BackupTimes parameter is invalid.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	The name of the RDS instance cannot be found. Check the name of the RDS instance.
404	InvalidDB.NotFound	Specified db does not exist or DB status does not support this operation.	The operation failed. The database cannot be found or is not in a ready state. You can call the DescribeDatabases operation to view the databases of an RDS instance.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
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.