All Products
Search
Document Center

Database Backup:CreateAdvancedPolicy

Last Updated:Nov 14, 2024

Enables an advanced backup policy for a PolarDB instance.

Operation description

Supported database engines

PolarDB for MySQL

Note This API operation is available only to specific customers. If you want to call this API operation, join the Database Backup (DBS) DingTalk group (ID 35585947) for customer consultation to request permissions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:CreateAdvancedPolicyupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionCodestringNo

The region in which backup sets reside.

cn-shanghai
InstanceNamestringNo

The ID of the PolarDB instance.

pc-2ze3nrr64c5****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1EFBAC73-4A72-5AD0-BE27-932491FCB848
Messagestring

The returned message.

instanceName can not be empty.
Databoolean

Indicates whether the advanced backup policy takes effect. Valid values:

  • true
  • false
true
ErrMessagestring

The error message returned if the request failed.

The specified parameter %s value is not valid.
Codestring

The response code.

Success
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrCodestring

The error code returned if the request failed.

Success

Examples

Sample success responses

JSONformat

{
  "RequestId": "1EFBAC73-4A72-5AD0-BE27-932491FCB848",
  "Message": "instanceName can not be empty.",
  "Data": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

Error codes

HTTP status codeError codeError message
403Request.ForbiddenHave no Permissions

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history