DescribeBackupPolicy - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Consulta la configuración de respaldo de una instancia de ApsaraDB RDS.

Descripción de la operación

Motores compatibles

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

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

rds:DescribeBackupPolicy

get

*DBInstance.

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a DescribeDBInstances para obtener el ID de la instancia.	rm-uf6wjk5****
BackupPolicyMode	string	No	El tipo de respaldo. Valores válidos: DataBackupPolicy: respaldo de datos LogBackupPolicy: respaldo de registros.	DataBackupPolicy
CompressType	string	No	El método de compresión del respaldo. Valores válidos: 0: sin compresión 1: compresión zlib 2: compresión zlib paralela 4: compresión QuickLZ con restauración rápida habilitada para bases de datos y tablas individuales 8: compresión QuickLZ, pero aún no se admite la restauración rápida para bases de datos y tablas individuales.	1
ReleasedKeepPolicy	string	No	La política de retención de datos de respaldo archivados para instancias MySQL eliminadas. Valores válidos: None: No se retienen respaldos archivados. Lastest: Solo se retiene el último respaldo archivado. All: Se retienen todos los respaldos archivados.	Lastest

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
ArchiveBackupKeepCount	string	El número de respaldos archivados que se retienen para la instancia MySQL.	1
ArchiveBackupKeepPolicy	string	El ciclo de retención de respaldos archivados para la instancia MySQL.	ByMonth
ArchiveBackupRetentionPeriod	string	El número de días durante los cuales se retienen los respaldos archivados para la instancia MySQL.	365
BackupInterval	string	El intervalo de respaldo. Unidad: minutos. Para instancias MySQL, este parámetro especifica la frecuencia de respaldo de instantáneas (no el ciclo de respaldo de instantáneas). Para instancias SQL Server, este parámetro especifica la frecuencia de respaldo de registros.	30
BackupLog	string	Indica si el respaldo de registros está habilitado. Valores válidos: Enable: habilitado Disabled: deshabilitado Para instancias SQL Server: Enable se devuelve solo cuando la frecuencia de respaldo de registros de la instancia es cada 5 minutos. Cuando la frecuencia de respaldo de registros de la instancia es cada 30 minutos o coincide con el ciclo de respaldo de datos, este parámetro devuelve Disabled. Utilice el valor de BackupInterval como referencia.	Enable
BackupMethod	string	El método de respaldo para instancias SQL Server con discos en la nube. Valores válidos: Physical: respaldo físico Snapshot: respaldo de instantánea.	Physical
BackupPriority	integer	La configuración de prioridad de respaldo para la instancia secundaria de una instancia SQL Server Enterprise Cluster Edition. Valores válidos: 1: Instancia secundaria preferida. 2: Instancia principal forzada. Nota Este parámetro se devuelve solo cuando SupportModifyBackupPriority es True.	2
BackupRetentionPeriod	integer	El número de días durante los cuales se retienen los respaldos de datos.	7
Category	string	Indica si el respaldo en segundos está habilitado para la instancia MySQL o PostgreSQL. Valores válidos: Flash: habilitado Standard: deshabilitado Nota Este parámetro surte efecto solo cuando el parámetro BackupPolicyMode se establece en DataBackupPolicy.	Standard
CompressType	string	El método de compresión del respaldo. Valores válidos: 0: sin compresión 1: compresión zlib 2: compresión zlib paralela 4: compresión QuickLZ con restauración rápida habilitada para bases de datos y tablas individuales 8: compresión QuickLZ, pero aún no se admite la restauración rápida para bases de datos y tablas individuales.	1
EnableBackupLog	string	Indica si el respaldo de registros está habilitado. Valores válidos: 1: habilitado 0: deshabilitado Para instancias SQL Server: 1 se devuelve solo cuando la frecuencia de respaldo de registros de la instancia es cada 5 minutos. Cuando la frecuencia de respaldo de registros de la instancia es cada 30 minutos o coincide con el ciclo de respaldo de datos, este parámetro devuelve 0. Utilice el valor de BackupInterval como referencia.	1
EnableIncrementDataBackup	boolean	Indica si el respaldo incremental está habilitado para la instancia SQL Server. Valores válidos: True: habilitado False: deshabilitado.	True
IncBackupInterval	integer
EnablePitrProtection	boolean	Indica si la recuperación a un punto en el tiempo (PITR) está habilitada para la instancia MySQL. PITR es una versión mejorada del respaldo de registros. Valores válidos: True: habilitado False: deshabilitado Nota Para más información, consulte Configurar una política de recuperación a un punto en el tiempo.	True
HighSpaceUsageProtection	string	Indica si los registros binarios se eliminan forzosamente cuando el uso de almacenamiento de la instancia MySQL supera el 80% o el almacenamiento restante es inferior a 5 GB. Valores válidos: Disable: Los registros binarios no se eliminan forzosamente. Enable: Los registros binarios se eliminan forzosamente.	Enable
LocalLogRetentionHours	integer	El número de horas durante las cuales se retienen localmente los respaldos de registros binarios para la instancia MySQL.	0
LocalLogRetentionSpace	string	El uso máximo de almacenamiento de los registros binarios almacenados localmente para la instancia MySQL.	30
LogBackupFrequency	string	La frecuencia de respaldo de registros para la instancia SQL Server. Valores válidos: LogInterval: cada 30 minutos. De forma predeterminada, la frecuencia de respaldo de registros coincide con el ciclo de respaldo de datos especificado por PreferredBackupPeriod.	LogInterval
LogBackupLocalRetentionNumber	integer	El número de registros binarios locales que se retienen para la instancia MySQL.	60
LogBackupRetentionPeriod	integer	El número de días durante los cuales se retienen los respaldos de registros.	7
PitrRetentionPeriod	integer	El número de días durante los cuales se admite la recuperación a un punto en el tiempo para la instancia MySQL.	7
PreferredBackupPeriod	string	El ciclo de respaldo de datos. Múltiples valores se separan con comas (,). Valores válidos: Monday: lunes Tuesday: martes Wednesday: miércoles Thursday: jueves Friday: viernes Saturday: sábado Sunday: domingo.	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	La hora de respaldo de datos. Formato: HH:mmZ-HH:mmZ (UTC).	15:00Z-16:00Z
PreferredNextBackupTime	string	La hora del próximo respaldo. Formato: yyyy-MM-ddTHH:mmZ (UTC).	2018-01-19T15:15Z
ReleasedKeepPolicy	string	La política de retención de datos de respaldo archivados para instancias MySQL eliminadas. Valores válidos: None: No se retienen respaldos archivados. Lastest: Solo se retiene el último respaldo archivado. All: Se retienen todos los respaldos archivados.	None
RequestId	string	El ID de la solicitud.	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	Indica si se puede modificar la opción de respaldo de la instancia secundaria para la instancia SQL Server. Valores válidos: True: La opción se puede modificar. False: La opción no se puede modificar.	False
SupportReleasedKeep	integer	Un parámetro reservado.	0
SupportVolumeShadowCopy	integer	Indica si se admite el respaldo de instantáneas para la instancia SQL Server. Valores válidos: 1: admitido 0: no admitido.	1
SupportsHighFrequencyBackup	integer	Indica si se admite la función de respaldo de registros cada 5 minutos para la instancia SQL Server. Valores válidos: 0: no admitido 1: admitido.	0
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>
	object
StrategyId	string
ActionType	string
OnlyPreserveOneEachHour	boolean
RetentionValue	integer
BakType	string
FilterKey	string
FilterValue	string
DestType	string
FilterType	string
SrcRegion	string
OnlyPreserveOneEachDay	boolean
SrcType	string
DestRegion	string
RetentionType	string
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>
	object
StrategyId	string
ActionType	string
LogRetentionType	string
DestType	string
EnableLogBackup	integer
SrcType	string
SrcRegion	string
LogRetentionValue	integer
DestRegion	string
FilterKey	string
FilterValue	string
AdvancedBackupPolicyEnabled	boolean

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 0,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "LogRetentionType": "",
        "DestType": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "SrcRegion": "",
        "LogRetentionValue": 0,
        "DestRegion": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	IO.Exception	IO exception, retry later.
400	InternalFailure	Internal failure, retry later.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

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.