EnableBackupLog-阿里云帮助中心

Operation description

Impact

Enabling log backup does not incur direct charges. However, log backups generate backup traffic and storage usage. These resources are billed at the same rate as full backups. You can use the free quota from your backup plan or storage plan to offset these charges.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:EnableBackupLog

update

*BackupPlan

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

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The backup plan ID. Call DescribeBackupPlanList to obtain this ID.	dbstooi******
ClientToken	string	No	A client-generated token that ensures the idempotency of the request.	dbs
EnableMysqlPhysicalBackupBinlog	string	No	Specifies whether to enable log backup for MySQL physical backups. Set the value to `true` to enable this feature.	true

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the operation succeeded. Valid values: `true`: The operation succeeded. `false`: The operation failed.	true
ErrMessage	string	The error message.	findValidDBSJob error
BackupPlanId	string	The backup plan ID.	dbstooi******
NeedPrecheck	boolean	Indicates whether this change triggers a precheck. Valid values: `true`: A precheck is triggered. You must call the StartBackupPlan operation to start the backup plan. `false`: No precheck is triggered.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "findValidDBSJob error",
  "BackupPlanId": "dbstooi******",
  "NeedPrecheck": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.