DescribeBackupPolicy - PolarDB - Centro de documentación de Alibaba Cloud

Consulta la política de copia de seguridad automática de un clúster de PolarDB.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeBackupPolicy

get

*dbcluster.

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster. Nota Puede llamar a la operación DescribeDBClusters para consultar la información de todos los clústeres en una región especificada, incluidos los ID de los clústeres.	pc-*************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>	Los detalles de la política de copia de seguridad avanzada. Nota Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL.
	object
AutoCreated	boolean	Indica si la política de copia de seguridad se genera de forma automática. Valores válidos: true: El sistema genera la política. false: La política está definida por el usuario.	true
BakType	string	El tipo de copia de seguridad. Valores válidos: F: copia de seguridad completa.	F
DestRegion	string	La región de destino de la política de copia de seguridad.	cn-hangzhou
DestType	string	El tipo de destino de la política de copia de seguridad. Valores válidos: level1: copia de seguridad de nivel 1 level2: copia de seguridad de nivel 2 level2Cross: copia de seguridad de nivel 2 entre regiones	level1
DumpAction	string	El método utilizado para convertir una copia de seguridad de nivel 1 en una copia de seguridad de nivel 2. Valores válidos: copy: copia	copy
FilterKey	string	El tipo de programación. Valores válidos: dayOfWeek: programación semanal dayOfMonth: programación mensual dayOfYear: programación anual backupInterval: programación de intervalo fijo Nota Este parámetro se devuelve solo cuando FilterType se establece en crontab.	dayOfWeek
FilterType	string	El tipo de filtro de la política avanzada. Valores válidos: crontab: programación periódica event: programación basada en eventos	crontab
FilterValue	string	El ciclo de copia de seguridad.	1,2,3,4,5,6,7
OnlyPreserveOneEachDay	boolean	La política de retención de datos de copia de seguridad de 24 horas. Valores válidos: true: Solo se conserva el primer conjunto de copias de seguridad del día para las copias de seguridad con más de 24 horas de antigüedad. false: Se conservan todos los conjuntos de copias de seguridad.	true
OnlyPreserveOneEachHour	boolean	La política de retención de datos de copia de seguridad por hora. Valores válidos: true: Solo se conserva el conjunto de copias de seguridad más antiguo dentro de cada hora para las copias de seguridad con más de 1 hora de antigüedad. false: Se conservan todos los conjuntos de copias de seguridad.	true
PolicyId	string	El ID de la política de copia de seguridad.	71930ac2e9f15e41615e10627c******
RetentionType	string	El tipo de retención del conjunto de copias de seguridad. Valores válidos: never: retención a largo plazo (LTR) delay: retención por un número fijo de días	delay
RetentionValue	string	El número de días durante los cuales se conservan las copias de seguridad.	7
SrcRegion	string	La región de origen de la política de copia de seguridad.	cn-beijing
SrcType	string	El tipo de origen de la política de copia de seguridad. Valores válidos: db: clúster de base de datos level1: copia de seguridad de nivel 1 level2: copia de seguridad de nivel 2 level2Cross: copia de seguridad de nivel 2 entre regiones	level1
StorageClass	string
AdvancedPolicyOption	string	La opción de política de copia de seguridad avanzada. Valores válidos: enable: La copia de seguridad avanzada está habilitada. disable: La copia de seguridad avanzada no está habilitada, pero se puede habilitar. notSupport: La copia de seguridad avanzada no es compatible. Nota Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL.	disable
BackupFrequency	string	La frecuencia de copia de seguridad. Valores válidos: Normal (predeterminado): copia de seguridad regular. Se realiza una copia de seguridad una vez al día a una hora programada. 2/24H: copia de seguridad mejorada. Se realiza una copia de seguridad cada 2 horas. 3/24H: copia de seguridad mejorada. Se realiza una copia de seguridad cada 3 horas. 4/24H: copia de seguridad mejorada. Se realiza una copia de seguridad cada 4 horas. Nota Después de habilitar la copia de seguridad mejorada, se conservan todas las copias de seguridad completadas en un plazo de 24 horas. Para las copias de seguridad con más de 24 horas de antigüedad, solo se conserva la primera copia de seguridad completada después de las 00:00 de cada día, y se eliminan todas las demás. Después de habilitar la copia de seguridad mejorada, el parámetro de ciclo de copia de seguridad PreferredBackupPeriod se establece de forma predeterminada en todos los días de la semana (de lunes a domingo).	Normal
BackupPolicyLevel	string	El nivel actual de la política de copia de seguridad. Valores válidos: Normal: copia de seguridad regular Advanced: copia de seguridad avanzada Nota Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL.	Normal
BackupRetentionPolicyOnClusterDeletion	string	Especifica si se deben conservar las copias de seguridad cuando se elimina el clúster. Valores válidos: ALL: Todas las copias de seguridad se conservan con retención a largo plazo (LTR). LATEST: La última copia de seguridad se conserva con retención a largo plazo (LTR). NONE (predeterminado): No se conserva ninguna copia de seguridad.	NONE
DataLevel1BackupFrequency	string	La frecuencia de copia de seguridad. Valores válidos: Normal (predeterminado): copia de seguridad regular. Se realiza una copia de seguridad una vez al día a una hora programada. 2/24H: copia de seguridad de alta frecuencia. Se realiza una copia de seguridad cada 2 horas. 3/24H: copia de seguridad de alta frecuencia. Se realiza una copia de seguridad cada 3 horas. 4/24H: copia de seguridad de alta frecuencia. Se realiza una copia de seguridad cada 4 horas. Nota Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL. Si la región de su clúster de PolarDB for MySQL no admite la función de copia de seguridad entre regiones, este parámetro no es compatible. Para conocer las regiones que admiten la copia de seguridad entre regiones, consulte Descripción general. Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	Normal
DataLevel1BackupPeriod	string	El ciclo de copia de seguridad de nivel 1. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Se deben seleccionar al menos dos días. Separe los múltiples valores con comas (,). Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL. Si la región de su clúster de PolarDB for MySQL no admite la función de copia de seguridad entre regiones, este parámetro no es compatible. Para conocer las regiones que admiten la copia de seguridad entre regiones, consulte Descripción general. Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	Monday,Tuesday
DataLevel1BackupRetentionPeriod	string	El período de retención de las copias de seguridad de nivel 1. Valores válidos: de 3 a 14. Unidad: días. Nota Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	7
DataLevel1BackupTime	string	El período de tiempo durante el cual se realizan las copias de seguridad automáticas. El valor está en el formato `hh:mmZ-hh:mmZ` (UTC). Las horas de inicio y fin deben ser en punto y estar separadas exactamente por 1 hora. Ejemplo: `14:00Z-15:00Z`. Nota Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL. Si la región de su clúster de PolarDB for MySQL no admite la función de copia de seguridad entre regiones, este parámetro no es compatible. Para conocer las regiones que admiten la copia de seguridad entre regiones, consulte Descripción general.	15:00Z-16:00Z
DataLevel2BackupAnotherRegionRegion	string	La región de copia de seguridad entre regiones para las copias de seguridad de nivel 2. Para conocer las regiones que admiten la copia de seguridad entre regiones, consulte Descripción general. Nota Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	cn-hangzhou
DataLevel2BackupAnotherRegionRetentionPeriod	string	El período de retención de las copias de seguridad entre regiones para las copias de seguridad de nivel 2. Valores válidos: 0: La función de copia de seguridad de nivel 2 está desactivada. 30 a 7300: El período de retención de las copias de seguridad de nivel 2. Unidad: días. -1: Las copias de seguridad de nivel 2 se conservan con retención a largo plazo (LTR). Nota Cuando se crea un clúster, el valor predeterminado es 0, lo que significa que la función de copia de seguridad entre regiones para las copias de seguridad de nivel 2 está desactivada. Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	30
DataLevel2BackupPeriod	string	El ciclo de copia de seguridad de nivel 2. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Se deben seleccionar al menos dos días. Separe los múltiples valores con comas (,). Este parámetro no es compatible con PolarDB for PostgreSQL (compatible con Oracle) ni con PolarDB for PostgreSQL. Si la región de su clúster de PolarDB for MySQL no admite la función de copia de seguridad entre regiones, este parámetro no es compatible. Para conocer las regiones que admiten la copia de seguridad entre regiones, consulte Descripción general. Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	Monday,Tuesday
DataLevel2BackupRetentionPeriod	string	El período de retención de las copias de seguridad de nivel 2. Valores válidos: 0: La función de copia de seguridad de nivel 2 está desactivada. 30 a 7300: El período de retención de las copias de seguridad de nivel 2. Unidad: días. -1: Las copias de seguridad de nivel 2 se conservan con retención a largo plazo (LTR). Nota Cuando se crea un clúster, el valor predeterminado es 0, lo que significa que la función de copia de seguridad de nivel 2 está desactivada. Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	0
EnableCrossRegionImmutableBackup	boolean	Indica si la copia de seguridad inmutable entre regiones está habilitada.
EnableImmutableBackup	boolean	Indica si la copia de seguridad inmutable está habilitada.
PreferredBackupPeriod	string	El ciclo de copia de seguridad de datos. Valores válidos: Lunes Martes Miércoles Jueves Viernes Sábado Domingo Nota Después de habilitar la copia de seguridad avanzada, utilice el parámetro AdvancedDataPolicies en lugar de este parámetro.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
PreferredBackupTime	string	El período de tiempo durante el cual se realizan las copias de seguridad automáticas. El valor está en el formato `HH:mmZ-HH:mmZ` (UTC).	07:00Z-08:00Z
PreferredNextBackupTime	string	La hora de la próxima copia de seguridad. El valor está en el formato `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-16T07:30Z
RequestId	string	El ID de la solicitud.	EADFCE0F-9FB5-4685-B395-1440B******

Ejemplos

Respuesta exitosa

JSON Formato

{
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "AutoCreated": true,
        "BakType": "F",
        "DestRegion": "cn-hangzhou",
        "DestType": "level1",
        "DumpAction": "copy",
        "FilterKey": "dayOfWeek",
        "FilterType": "crontab",
        "FilterValue": "1,2,3,4,5,6,7",
        "OnlyPreserveOneEachDay": true,
        "OnlyPreserveOneEachHour": true,
        "PolicyId": "71930ac2e9f15e41615e10627c******\n",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "SrcRegion": "cn-beijing",
        "SrcType": "level1",
        "StorageClass": ""
      }
    ]
  },
  "AdvancedPolicyOption": "disable",
  "BackupFrequency": "Normal",
  "BackupPolicyLevel": "Normal",
  "BackupRetentionPolicyOnClusterDeletion": "NONE",
  "DataLevel1BackupFrequency": "Normal",
  "DataLevel1BackupPeriod": "Monday,Tuesday",
  "DataLevel1BackupRetentionPeriod": "7",
  "DataLevel1BackupTime": "15:00Z-16:00Z",
  "DataLevel2BackupAnotherRegionRegion": "cn-hangzhou",
  "DataLevel2BackupAnotherRegionRetentionPeriod": "30",
  "DataLevel2BackupPeriod": "Monday,Tuesday",
  "DataLevel2BackupRetentionPeriod": "0",
  "EnableCrossRegionImmutableBackup": false,
  "EnableImmutableBackup": false,
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredBackupTime": "07:00Z-08:00Z",
  "PreferredNextBackupTime": "2020-11-16T07:30Z",
  "RequestId": "EADFCE0F-9FB5-4685-B395-1440B******"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	La operación falló porque el ID de instancia de clúster especificado no existe.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	El DBClusterId proporcionado no existe en los registros actuales.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.