All Products
Search

This Product

    PolarDB:DescribeLogBackupPolicy

    Document Center

    PolarDB:DescribeLogBackupPolicy

    Last Updated:Jun 17, 2024

    Queries the retention policy of log backups in a PolarDB cluster.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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
    polardb:DescribeLogBackupPolicyRead
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the cluster.

    Note You can call the DescribeDBClusters operation to query all the information about the available clusters in the target region, including the cluster ID.
    		pc-*****************

    Response parameters

    ParameterTypeDescriptionExample
    object
    LogBackupRetentionPeriodinteger

    The retention period of the log backups. Valid values:

    • 3 to 7300: The log backups are retained for 3 to 7,300 days.
    • -1: The log backups are permanently retained.
    		7
    RequestIdstring

    The request ID.

    		62EE0051-102B-488D-9C79-D607B8******
    LogBackupAnotherRegionRetentionPeriodstring

    The retention period of cross-region log backups. Valid values:

    • 0: The cross-region backup feature is disabled.
    • 30 to 7300: Cross-region log backups are retained for 30 to 7,300 days.
    • -1: The log backups are permanently retained.
    Note When you create a cluster, the default value of this parameter is 0.
    		0
    LogBackupAnotherRegionRegionstring

    The region in which you want to store cross-region log backups. For more information about regions that support the cross-region backup feature, see Overview .

    		cn-beijing
    EnableBackupLoginteger

    Indicates whether the log backup feature is enabled. Valid values:

    • 0: The log backup feature is disabled.
    • 1: The log backup feature is enabled. By default, the log backup feature is enabled and cannot be disabled.
    		1

    Examples

    Sample success responses

    JSONformat

    {
  "LogBackupRetentionPeriod": 7,
  "RequestId": "62EE0051-102B-488D-9C79-D607B8******",
  "LogBackupAnotherRegionRetentionPeriod": "0",
  "LogBackupAnotherRegionRegion": "cn-beijing",
  "EnableBackupLog": 1
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
      delete Error Codes: 400
    2022-06-01The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
    Output ParametersThe response structure of the API has changed.