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

Configura um plano de backup 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:ConfigureBackupPlan

update

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BackupPlanId	string	Sim	O ID do plano de backup. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro.	dbstooi0*******
SourceEndpointInstanceType	string	Sim	O local do banco de dados. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Valores válidos: RDS ECS Express: bancos de dados conectados por meio de circuitos do Express Connect, gateways de VPN ou Smart Access Gateway (SAG) Agent: bancos de dados conectados por meio de gateways de backup DDS: ApsaraDB for MongoDB Other: bancos de dados conectados usando endereços IP e números de porta	RDS
SourceEndpointRegion	string	Não	A região do banco de dados. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Este parâmetro é obrigatório quando SourceEndpointInstanceType está definido como RDS, ECS, DDS, Express ou Agent.	cn-hangzhou
SourceEndpointInstanceID	string	Não	O ID da instância do banco de dados. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Este parâmetro é obrigatório quando SourceEndpoint.InstanceType está definido como RDS, ECS, DDS ou Express.	rm-uf6wjk5*********
SourceEndpointIP	string	Não	O endereço de conexão do banco de dados. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Este parâmetro é obrigatório quando SourceEndpointInstanceType está definido como express, agent ou other.	rm-uf6wjk5*******.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	Não	O número da porta do banco de dados. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Este parâmetro é obrigatório quando SourceEndpoint.InstanceType está definido como express, agent, other ou ECS.	3306
SourceEndpointDatabaseName	string	Não	O nome do banco de dados. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Este parâmetro é obrigatório quando o mecanismo do banco de dados é PostgreSQL ou MongoDB.	testRDS
SourceEndpointUserName	string	Não	O nome de usuário da conta do banco de dados. Nota Este parâmetro não é obrigatório quando o mecanismo do banco de dados é Redis, ou quando o banco de dados está conectado por meio de um gateway de backup (agent) e o mecanismo do banco de dados é SQL Server. Este parâmetro é obrigatório em outros cenários.	testRDS
SourceEndpointPassword	string	Não	A senha da conta do banco de dados. Nota Este parâmetro não é obrigatório quando o mecanismo do banco de dados é Redis, ou quando o banco de dados está conectado por meio de um gateway de backup (agent) e o mecanismo do banco de dados é SQL Server. Este parâmetro é obrigatório em outros cenários.	testPassword
BackupGatewayId	integer	Não	O ID do gateway de backup. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Este parâmetro é obrigatório quando SourceEndpointInstanceType está definido como agent.	23313123312
OSSBucketName	string	Não	O nome do bucket do OSS. Nota Por padrão, o sistema gera automaticamente um novo nome.	TestOssBucket
BackupObjects	string	Não	Os objetos a serem submetidos a backup. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro.	[ { "DBName":"DatabaseToBackUp", "SchemaName":"SchemaToBackUp", "TableIncludes":[{ "TableName":"TableToBackUp" }], "TableExcludes":[{ "TableName":"TableToExclude" }] } ]
BackupPeriod	string	Não	O ciclo de backup completo. 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
BackupStartTime	string	Não	A hora de início do backup completo. A hora está no formato HH:mmZ e é exibida em UTC. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro.	14:22
EnableBackupLog	boolean	Não	Especifica se o backup de log incremental deve ser ativado. Valores válidos: true: ativa o backup de log incremental false: desativa o backup de log incremental	true
BackupLogIntervalSeconds	integer	Não	O intervalo para backup incremental, em segundos. Nota Este parâmetro é compatível apenas com backup físico.	1000
BackupRetentionPeriod	integer	Não	O período de retenção dos dados de backup. Valores válidos: 0 a 1825. Valor padrão: 730. Unidade: dias.	730
DuplicationInfrequentAccessPeriod	integer	Não	O período após o qual os dados de backup são transferidos para o armazenamento de acesso infrequente (IA). Valor padrão: 180. Unidade: dias.	180
DuplicationArchivePeriod	integer	Não	O período após o qual os dados de backup são transferidos para o armazenamento Archive. Valor padrão: 365. Unidade: dias.	365
BackupPlanName	string	Sim	O nome personalizado do plano de backup. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro.	dbstooi0*******
SourceEndpointOracleSID	string	Não	O identificador de sistema (SID) do Oracle. Nota Este parâmetro é obrigatório quando o mecanismo do banco de dados é Oracle.	test
BackupStorageType	string	Não	O tipo de armazenamento integrado. Valores válidos: String vazia (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.	None
BackupSpeedLimit	integer	Não	O limite de E/S do disco. Unidade: KB/s. Nota Este parâmetro entra em vigor apenas para backup físico do MySQL.	262144
BackupRateLimit	integer	Não	A limitação de largura de banda da rede. Unidade: KB/s. Valor máximo: 10 GB. Nota Este parâmetro entra em vigor apenas para backup físico do MySQL.	262144
BackupStrategyType	string	Não	A época do backup completo. Valores válidos: simple: backup periódico, que é usado junto com BackupPeriod e BackupStartTime manual: backup manual Nota Valor padrão: simple.	simple
CrossAliyunId	string	Não	O UID da conta Alibaba Cloud para backup entre contas. Você pode chamar a operação DescribeRestoreTaskList para consultar o valor deste parâmetro.	2xxx7778xxxxxxxxxx
CrossRoleName	string	Não	O nome da função RAM para backup entre contas. Você pode chamar a operação DescribeRestoreTaskList para consultar o valor deste parâmetro.	test123
AutoStartBackup	boolean	Não	Especifica se o backup automático deve ser ativado. Valores válidos: true: ativa o backup automático false: desativa o backup automático	false
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação e evitar envios duplicados. Você pode usar o cliente para gerar o valor e deve garantir que o valor seja exclusivo entre diferentes solicitações. O valor pode ter até 64 caracteres ASCII e não pode conter caracteres não ASCII.	ETnLKlblzczshOTUbOCzxxxxxxx
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aekzecovzti****
EnableSourceEndpointSsl	string	Não	Especifica se uma conexão criptografada por SSL para a instância do banco de dados de origem deve ser ativada.	true
BackupStorageEncryptMethod	string	Não	O método de criptografia para o armazenamento de backup.	encrypted
SslCaPem	string	Não	O certificado PEM para a conexão criptografada por SSL com o banco de dados de origem.	-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
SourceEndpointOracleHome	string	Não	O Oracle Home.	/home/test
EnableMysqlPhysicalBackupBinlog	string	Não	Especifica se o backup de log para backup físico do MySQL deve ser ativado.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	F1FB49D4-B504-47F1-9F43-D7EAB33F****
ErrCode	string	O código de erro.	Param.NotFound
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
ErrMessage	string	A mensagem de erro.	The specified parameter %s value is not valid.
BackupPlanId	string	O ID do plano de backup.	dbstooi01ex****

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "BackupPlanId": "dbstooi01ex****"
}

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.