CreateAndStartBackupPlan - Data Management: Central de Documentação do Alibaba Cloud

Cria, configura e inicia um plano de backup.

Descrição da operação

Antes de chamar esta operação, certifique-se de entender os métodos de cobrança e preços do Database Backup (DBS).

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

dbs:CreateAndStartBackupPlan

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BackupPlanId	string	Não	O ID do plano de backup.	dbstooi0*******
Region	string	Não	A região onde o DBS está disponível. Para visualizar as regiões disponíveis, chame a operação DescribeRegions.	cn-hangzhou
InstanceClass	string	Sim	A especificação do plano de backup. Valores válidos: micro small medium large xlarge Nota Especificações superiores oferecem melhor desempenho de backup e recuperação. Para mais informações, consulte Especificações.	micro
DatabaseType	string	Sim	O tipo de banco de dados. Valores válidos: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis	MySQL
BackupMethod	string	Sim	O método de backup. Valores válidos: logical: backup lógico physical: backup físico	logical
Period	string	Não	O ciclo de cobrança da instância por assinatura. Valores válidos: Year Month	Year
UsedTime	integer	Não	A duração da assinatura. Valores válidos: Se Period estiver definido como Year, o valor de UsedTime pode ser de 1 a 5. Se Period estiver definido como Month, o valor de UsedTime pode ser de 1 a 11.	1
PayType	string	Não	O método de pagamento. Valor válido: prepay: assinatura	prepay
DatabaseRegion	string	Não	A região onde o banco de dados está localizado.	cn-hangzhou
StorageRegion	string	Não	A região de armazenamento.	cn-hangzhou
InstanceType	string	Não	O tipo de instância de banco de dados. Valores válidos: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: Um banco de dados conectado por meio de um endereço IP e porta. dg: Um banco de dados autogerenciado sem endereço IP público ou porta, conectado por meio do Database Gateway (DG).	RDS
StorageType	string	Não	Este parâmetro ainda não está disponível.	无
FromApp	string	Não	A origem da solicitação. O valor padrão é OpenApi. Você não precisa definir este parâmetro.	OpenApi
SourceEndpointInstanceType	string	Sim	A localização do banco de dados. Valores válidos: RDS ECS Express: Um banco de dados conectado por meio de uma linha dedicada, VPN Gateway ou Smart Access Gateway. Agent: Um banco de dados conectado por meio de um gateway de backup. DDS: Alibaba Cloud MongoDB Other: Um banco de dados conectado diretamente por meio de um endereço IP e porta. dg: Um banco de dados autogerenciado sem endereço IP público ou porta, conectado por meio do Database Gateway (DG).	RDS
SourceEndpointRegion	string	Não	A região onde o banco de dados está localizado. Nota Este parâmetro é obrigatório se SourceEndpoint.InstanceType estiver definido como RDS, ECS, DDS, Express ou Agent.	cn-hangzhou
SourceEndpointInstanceID	string	Não	O ID da instância de banco de dados. Nota Este parâmetro é obrigatório se SourceEndpoint.InstanceType estiver definido como RDS, ECS, DDS ou Express.	rm-uf6wjk5xxxxxxxxxx
SourceEndpointIP	string	Não	O endpoint do banco de dados. Nota Este parâmetro é obrigatório se SourceEndpoint.InstanceType estiver definido como express, agent ou other.	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	Não	A porta do banco de dados. Nota Este parâmetro é obrigatório se SourceEndpoint.InstanceType estiver definido como express, agent, other ou ECS.	3306
SourceEndpointDatabaseName	string	Não	O nome do banco de dados. Nota Este parâmetro é obrigatório se o tipo de banco de dados for PostgreSQL ou MongoDB.	testRDS
SourceEndpointUserName	string	Não	A conta do banco de dados. Nota Este parâmetro é opcional se o tipo de banco de dados for Redis, ou se a localização do banco de dados for agent e o tipo de banco de dados for MSSQL. Em todos os outros casos, este parâmetro é obrigatório.	testRDS
SourceEndpointPassword	string	Não	A senha da conta do banco de dados. Nota Este parâmetro é opcional se o tipo de banco de dados for Redis, ou se a localização do banco de dados for agent e o tipo de banco de dados for MSSQL. Em todos os outros casos, este parâmetro é obrigatório.	testPassword
BackupGatewayId	integer	Não	O ID do gateway de backup. Nota Este parâmetro é obrigatório se SourceEndpoint.InstanceType estiver definido como agent. Para mais informações sobre como criar um gateway de backup, consulte Adicionar um gateway de backup. Você pode chamar a operação DescribeBackupGatewayList para visualizar a lista de gateways de backup existentes.	23313123312
OSSBucketName	string	Não	O nome do bucket do Object Storage Service (OSS). Valor padrão: O sistema gera automaticamente um novo nome.	TestOssBucket
BackupObjects	string	Não	Os objetos de backup.	[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
BackupPeriod	string	Não	O ciclo de backup completo. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Você pode selecionar vários valores. Separe-os com vírgulas (,).	Monday
BackupStartTime	string	Não	A hora de início do backup completo. A hora está no formato HH:mm e em UTC.	14:22
EnableBackupLog	boolean	Não	Especifica se o backup de log incremental deve ser ativado. Valores válidos: true false	true
BackupLogIntervalSeconds	integer	Não	O intervalo para backups incrementais, em segundos. Nota Este parâmetro é obrigatório apenas para backups físicos.	1000
BackupRetentionPeriod	integer	Não	O período de retenção dos dados de backup, em dias. Valores válidos: 0 a 1825. Valor padrão: 730.	730
DuplicationInfrequentAccessPeriod	integer	Não	O tempo após o qual os dados de backup são convertidos para armazenamento de acesso infrequente (IA), em dias. Valor padrão: 180.	180
DuplicationArchivePeriod	integer	Não	O tempo após o qual os dados de backup são convertidos para armazenamento de arquivamento, em dias. Valor padrão: 365.	365
BackupPlanName	string	Sim	O nome personalizado do plano de backup.	dbstooi0*******
SourceEndpointOracleSID	string	Não	O ID do sistema Oracle (SID). Este parâmetro é obrigatório se o tipo de banco de dados for Oracle.	test
BackupStorageType	string	Não	O tipo de armazenamento integrado: Vazio (padrão): Os dados de backup são armazenados no seu bucket do OSS. system: Os dados de backup são armazenados no bucket do OSS integrado do DBS.	无
BackupSpeedLimit	integer	Não	O limite de E/S do disco, em KB/s. Nota Este parâmetro é válido apenas para backups físicos do MySQL.	262144
BackupRateLimit	integer	Não	O limite de largura de banda da rede, em KB/s. O valor máximo permitido é 10 GB. Nota Este parâmetro é válido apenas para backups físicos do MySQL.	262144
BackupStrategyType	string	Não	A estratégia de backup completo. Valores válidos: simple: backup periódico. Use este valor com BackupPeriod e BackupStartTime. manual: backup manual. Nota O valor padrão é simple.	simple
CrossAliyunId	string	Não	O UID da conta Alibaba Cloud para backup entre contas.	1648821913******
CrossRoleName	string	Não	O nome da função RAM para backup entre contas.	test123
ClientToken	string	Não	Um token de cliente usado para garantir a idempotência da solicitação. Isso evita solicitações duplicadas.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aekzecovzti****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	4F1888AC-1138-4995-B9FE-D2734F61C058
CreateBackupSet	boolean	Indica se o conjunto de backup está ativado. O valor retornado é um dos seguintes: true: Ativado false: Desativado	true
ErrCode	string	O código de erro.	Param.NotFound
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrMessage	string	A mensagem de erro.	The specified parameter %s value is not valid.
BackupPlanId	string	O ID do plano de backup.	dbs1hvb0wwwe****
OrderId	string	O ID do pedido.	2056157***

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "CreateBackupSet": true,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbs1hvb0wwwe****",
  "OrderId": "2056157***"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Request.Forbidden	Have no Permissions

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.