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

Esta API se utiliza para consultar la lista de conjuntos de respaldo de una instancia de 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:DescribeBackups

get

DBInstance.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-uf6wjk5****
BackupId	string	No	El ID del conjunto de respaldo.	327329803
BackupStatus	string	No	El estado del conjunto de respaldo. Valores válidos: Success Failed	Success
BackupMode	string	No	El modo de respaldo. Valores válidos: Automated Manual	Automated
StartTime	string	No	El inicio del intervalo de tiempo que se va a consultar. Especifique la hora en formato ISO 8601 con el patrón yyyy-MM-ddTHH:mmZ. La hora debe estar en UTC.	2011-06-01T16:00Z
EndTime	string	No	El fin del intervalo de tiempo que se va a consultar. La hora de finalización debe ser posterior a la hora de inicio. Especifique la hora en formato ISO 8601 con el patrón yyyy-MM-ddTHH:mmZ. La hora debe estar en UTC. Nota Se recomienda especificar un intervalo de tiempo lo más corto posible para evitar tiempos de espera agotados.	2011-06-15T16:00Z
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100 Valor predeterminado: 30.	30
PageNumber	integer	No	El número de la página que se va a devolver. Valores válidos: cualquier entero positivo distinto de cero. Valor predeterminado: 1.	1
BackupType	string	No	El tipo de respaldo. Valores válidos: FullBackup: respaldo completo IncrementalBackup: respaldo incremental	FullBackup

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
Items	object
Backup	array<object>	Los conjuntos de respaldo devueltos.
	array<object>	Los detalles de los conjuntos de respaldo devueltos.
BackupDownloadLinkByDB	object
BackupDownloadLinkByDB	array<object>	Una matriz compuesta por URL desde las cuales puede descargar conjuntos de respaldo de bases de datos individuales.
	object
DataBase	string	El nombre de la base de datos.	dbs
DownloadLink	string	La URL pública desde la cual puede descargar el conjunto de respaldo.	https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
IntranetDownloadLink	string	La URL interna desde la cual puede descargar el conjunto de respaldo.	https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
BackupDownloadURL	string	La URL que se utiliza para descargar el conjunto de respaldo a través de Internet. Si no es posible descargar el conjunto de respaldo, se devuelve null. Nota Por ejemplo, si BackupMethod de una instancia de ApsaraDB RDS for SQL Server está configurado como Snapshot, se devuelve una cadena nula.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
BackupEndTime	string	La hora de finalización de la tarea de respaldo. La hora sigue el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mmZ. La hora se muestra en UTC.	2019-02-13T12:20:00Z
BackupId	string	El ID del conjunto de respaldo.	321020562
BackupInitiator	string	El iniciador de la tarea de respaldo. Valores válidos: System User	System
BackupIntranetDownloadURL	string	La URL que se utiliza para descargar el conjunto de respaldo a través de una red interna. Si no es posible descargar el conjunto de respaldo, se devuelve null. Nota Por ejemplo, si BackupMethod de una instancia de ApsaraDB RDS for SQL Server está configurado como Snapshot, se devuelve una cadena nula.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****
BackupMethod	string	El método que se utiliza para generar el conjunto de respaldo. Valores válidos: Logical: respaldo lógico Physical: respaldo físico Snapshot: respaldo de instantánea	Physical
BackupMode	string	El modo de respaldo del conjunto de respaldo. Valores válidos: Automated Manual	Automated
BackupSize	integer	El tamaño del archivo de respaldo de datos. Unidad: bytes.	2167808
BackupStartTime	string	La hora de inicio del respaldo. La hora sigue el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mmZ. La hora se muestra en UTC.	2019-02-03T12:20:00Z
BackupStatus	string	El estado del conjunto de respaldo.	Success
BackupType	string	El tipo de respaldo del conjunto de respaldo. Valores válidos: FullBackup IncrementalBackup	FullBackup
Checksum	string	La suma de comprobación. El valor de este parámetro se calcula mediante el algoritmo CRC64.	1835830439****
ConsistentTime	integer	El momento en el que los datos del conjunto de respaldo son consistentes. El valor devuelto de este parámetro es una marca de tiempo. Nota Si la instancia ejecuta MySQL 5.6, se devuelve una marca de tiempo. De lo contrario, se devuelve el valor 0.	1576506856
CopyOnlyBackup	string	El modo de respaldo del conjunto de respaldo. Valores válidos: 0: el modo estándar. Este modo admite respaldos completos y respaldos incrementales. 1: el modo de solo copia. Este modo admite únicamente respaldos completos. Nota Este parámetro se devuelve solo cuando la instancia ejecuta SQL Server.	0
DBInstanceId	string	El ID de la instancia.	rm-uf6wjk5****
Encryption	string	La información de cifrado del conjunto de respaldo.	{}
Engine	string	El tipo de motor de base de datos. Valores válidos: MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	La versión del motor de base de datos.	8.0
HostInstanceID	string	El ID de la instancia que genera el conjunto de respaldo. Este parámetro se utiliza para indicar si la instancia que genera el conjunto de respaldo es una instancia principal o una instancia secundaria.	5882781
IsAvail	integer	Indica si el conjunto de respaldo está disponible. Valores válidos: 0: El conjunto de respaldo no está disponible. 1: El conjunto de respaldo está disponible.	1
MetaStatus	string	El estado del conjunto de respaldo que se utiliza para restaurar bases de datos o tablas individuales. Valores válidos: OK: El archivo de respaldo de datos es normal. LARGE: El archivo de respaldo de datos contiene una cantidad anormalmente grande de tablas. No se puede utilizar para restaurar bases de datos o tablas individuales. EMPTY: El archivo de respaldo de datos se generó a partir de una tarea de respaldo fallida. Nota Si se devuelve una cadena vacía, el archivo de respaldo de datos no se puede utilizar para restaurar bases de datos o tablas individuales.	OK
StorageClass	string	La clase de almacenamiento del conjunto de respaldo. Valores válidos: 0: almacenamiento estándar 1: almacenamiento de archivo	0
StoreStatus	string	Indica si el conjunto de respaldo se puede eliminar. Valores válidos: Enabled: El conjunto de respaldo se puede eliminar. Disabled: El conjunto de respaldo no se puede eliminar.	Disabled
ExpectExpireTime	string	La hora de caducidad del conjunto de respaldo, en formato yyyy-MM-ddTHH:mmZ (hora UTC). Nota Este valor se devuelve solo para respaldos de base de datos única de instancias de SQL Server cuando se configuran los días de retención de respaldo.	2025-06-17T12:10:23Z
PageNumber	string	El número de la página devuelta.	1
PageRecordCount	string	El número de conjuntos de respaldo en la página actual.	30
RequestId	string	El ID de la solicitud.	1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSize	integer	El tamaño de la cadena de instantáneas de la instancia. Unidad: bytes.	0
TotalRecordCount	string	El número total de entradas devueltas.	100

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Items": {
    "Backup": [
      {
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
            }
          ]
        },
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "BackupMethod": "Physical",
        "BackupMode": "Automated",
        "BackupSize": 2167808,
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "Checksum": "1835830439****",
        "ConsistentTime": 1576506856,
        "CopyOnlyBackup": "0",
        "DBInstanceId": "rm-uf6wjk5****",
        "Encryption": "{}",
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "HostInstanceID": "5882781",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "StorageClass": "0",
        "StoreStatus": "Disabled",
        "ExpectExpireTime": "2025-06-17T12:10:23Z"
      }
    ]
  },
  "PageNumber": "1",
  "PageRecordCount": "30",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "TotalRecordCount": "100"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidRestoreTime.Malformed	The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.
400	InvalidPageNumbers.Malformed	Specified page number is not valid.
400	InvalidStartTime.Format	Specified start time is not valid.
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidParameterCombination	The end time must be greater than the start time
400	InvalidDBinstanceClass.ValueNotSupported	The specified parameter DBinstanceClass is invalid.
400	InvalidBackupSetLocation.Format	Specified backup set location 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	InvalidMaxRecordsPerPage.Malformed	Specified record number is not valid.
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	InvalidDBInstanceName.NotFound	The database instance does not exist.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.
404	Request.NotFound	The requested resource is not available.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
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.