配置备份计划 - 数据库备份 DBS

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ConfigureBackupPlan	系统规定参数，取值：ConfigureBackupPlan。
BackupPlanId	String	是	dbstooi0*******	备份计划ID。
BackupPlanName	String	是	dbstooi0*******	备份计划名称。
SourceEndpointInstanceType	String	是	RDS	数据库所在位置，取值： RDS ECS Express：通过专线/VPN网关/智能网关接入的数据库 Agent：通过备份网关接入的数据库 DDS：云MongoDB Other：通过IP:Port直连的数据库
SourceEndpointRegion	String	否	cn-hangzhou	数据库地域。说明 SourceEndpoint.InstanceType为RDS、ECS、DDS、Express、Agent时，该参数必传。
SourceEndpointInstanceID	String	否	rm-uf6wjk5xxxxxxxxxx	数据库实例ID。说明 SourceEndpoint.InstanceType为RDS、ECS、DDS、Express时，该参数必传。
SourceEndpointIP	String	否	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	数据库连接地址。说明 SourceEndpoint.InstanceType为express、agent、other，该参数必传。
SourceEndpointPort	Integer	否	3306	数据库端口。说明 SourceEndpoint.InstanceType为express、agent、other、ECS，该参数必传。
SourceEndpointDatabaseName	String	否	testRDS	数据库名称。说明数据库类型为PostgreSQL、MongoDB时，该参数必传。
SourceEndpointUserName	String	否	testRDS	数据库账号。说明数据库类型为Redis，或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。
SourceEndpointPassword	String	否	testPassword	密码。说明数据库类型为Redis，或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须，其他场景均必传。
BackupGatewayId	Long	否	23313123312	备份网关ID。说明 SourceEndpoint.InstanceType为agent时，该参数必传。
OSSBucketName	String	否	TestOssBucket	OSS Bucket名称。默认：系统自动生成新的名称。
BackupObjects	String	否	[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]	备份对象。
BackupPeriod	String	否	Monday	全量备份周期，取值： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日
BackupStartTime	String	否	14:22	全量备份开始时间，格式为HH:mmZ（UTC时间）。
EnableBackupLog	Boolean	否	true	是否开启增量日志备份，取值： true：开启 false：关闭
BackupRetentionPeriod	Integer	否	730	备份数据保留时间，取值：0-1825，默认为730。
DuplicationInfrequentAccessPeriod	Integer	否	180	转为低频访问存储时间，默认为180。
DuplicationArchivePeriod	Integer	否	365	转为归档冷备存储时间，默认为365。
SourceEndpointOracleSID	String	否	test	Oracle SID名称，数据库类型为Oracle时，该参数必传。
BackupStorageType	String	否	无	内置存储类型：默认空：备份数据存储在用户OSS上。 system ：备份数据存储在DBS的内置OSS上。
RegionId	String	否	cn-hangzhou	地域ID，调用DescribeRegions接口查看DBS支持地域。
ClientToken	String	否	ETnLKlblzczshOTUbOCzxxxxxxx	用于保证请求的幂等性，防止重复提交请求。

返回数据


名称	类型	示例值	描述
BackupPlanId	String	dbstooi01ex7ltj	备份计划ID。
ErrCode	String	Param.NotFound	错误码。
ErrMessage	String	The specified parameter %s value is not valid.	错误信息。
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	F1FB49D4-B504-47F1-9F43-D7EAB33FD1E4	请求ID。
Success	Boolean	true	是否成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ConfigureBackupPlan
&BackupPlanId=dbstooi01ex7ltj
&BackupPlanName=dbstooi01ex7ltj
&SourceEndpointInstanceType=rds
&<公共请求参数>

正常返回示例

XML 格式

<ConfigureBackupPlanReponse>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <BackupPlanId>dbs1h****usfa</BackupPlanId>
  <Success>true</Success>
</ConfigureBackupPlanReponse>

JSON 格式

{
	"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
	"HttpStatusCode": 200,
	"BackupPlanId": "dbs1h****usfa",
	"Success": true
}

错误码

访问错误中心查看更多错误码。