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

Consulta los archivos de respaldo de datos entre regiones de una instancia.

Descripción de la operación

Motores de base de datos compatibles

Instancias de ApsaraDB RDS for MySQL con discos locales
RDS PostgreSQL
RDS SQL Server

Referencias

Nota

Antes de llamar a esta operación, lea detenidamente la siguiente documentación. Asegúrese de comprender completamente los requisitos previos y los impactos de llamar a esta operación.

Uso de la función de respaldo entre regiones para una instancia de ApsaraDB RDS for MySQL
Uso de la función de respaldo entre regiones para una instancia de ApsaraDB RDS for SQL Server
Uso de la función de respaldo entre regiones para una instancia de ApsaraDB RDS for PostgreSQL

Nota

Para obtener más información sobre cómo consultar archivos de respaldo de registros entre regiones, consulte DescribeCrossRegionLogBackupFiles.

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:DescribeCrossRegionBackups

get

*DBInstance.

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

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.	rm-uf6wjk5****
RegionId	string	Sí	El ID de la región.	cn-hangzhou
CrossBackupRegion	string	No	El ID de la región en la que se almacena el archivo de respaldo de datos entre regiones.	cn-shanghai
CrossBackupId	integer	No	El ID del archivo de respaldo de datos entre regiones. Nota Debe especificar el parámetro CrossBackupId. Alternativamente, debe especificar los parámetros StartTime y EndTime.	14562
StartTime	string	No	El inicio del intervalo de tiempo a consultar. Especifique la hora en formato ISO 8601 yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC.	2024-03-05T02:21:00Z
EndTime	string	No	El final del intervalo de tiempo a consultar. Especifique la hora en formato ISO 8601 yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC.	2024-03-05T02:24:37Z
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 página. Valores válidos: cualquier entero positivo distinto de cero. Valor predeterminado: 1.	1
BackupId	integer	No	El ID del archivo de respaldo.	603524****
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmy****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
EndTime	string	El final del intervalo de tiempo a consultar.	2019-06-15T12:10:00Z
Items	object
Item	array<object>	Los archivos de respaldo de datos entre regiones.
	array<object>
BackupEndTime	string	La hora en que se generó el archivo de respaldo de datos entre regiones.	2024-03-05T02:23:37Z
BackupMethod	string	El método utilizado para generar el archivo de respaldo de datos entre regiones. Valores válidos: L: respaldo lógico P: respaldo físico	P
BackupSetScale	integer	El nivel en el que se genera el archivo de respaldo de datos entre regiones. 0: respaldo a nivel de instancia 1: respaldo a nivel de base de datos	0
BackupSetStatus	integer	El estado del respaldo de datos entre regiones. Valores válidos: 0: El respaldo de datos entre regiones se realizó correctamente. 1: El respaldo de datos entre regiones falló.	0
BackupStartTime	string	La hora en que comenzó el respaldo de datos entre regiones.	2024-03-05T02:22:45Z
BackupType	string	El tipo de respaldo de datos entre regiones. Valores válidos: F: respaldo completo de datos I: respaldo incremental de datos	F
Category	string	La edición de RDS de la instancia. Valores válidos: Basic: RDS Basic Edition. HighAvailability: RDS High-availability Edition. Finance: RDS Enterprise Edition. Esta edición solo está disponible para el sitio de China (aliyun.com).	HighAvailability
ConsistentTime	string	El punto en el tiempo que indican los datos en el archivo de respaldo de datos entre regiones.	2024-03-05T02:22:54Z
CrossBackupDownloadLink	string	La URL externa desde la cual puede descargar el archivo de respaldo de datos entre regiones.	http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****
CrossBackupId	integer	El ID del archivo de respaldo de datos entre regiones.	1249****
CrossBackupRegion	string	El ID de la región en la que se almacenan los archivos de respaldo entre regiones de la instancia.	cn-shanghai
CrossBackupSetFile	string	El nombre del paquete comprimido que contiene el archivo de respaldo de datos entre regiones.	cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb
CrossBackupSetLocation	string	La ubicación donde se almacena el archivo de respaldo de datos entre regiones.	oss
CrossBackupSetSize	integer	El tamaño del archivo de respaldo de datos entre regiones. Unidad: bytes.	5312836
DBInstanceStorageType	string	El tipo de almacenamiento. Valores válidos: local_ssd: SSD local. Este es el tipo de almacenamiento recomendado. cloud_ssd: SSD estándar. cloud_essd: SSD mejorado (ESSD).	ssd
Engine	string	El motor de base de datos de la instancia.	mysql
EngineVersion	string	La versión del motor de base de datos.	5.6
InstanceId	integer	El ID de la instancia. Este parámetro se utiliza para determinar si la instancia que genera el archivo de respaldo de datos entre regiones es una instancia principal o secundaria.	8161***
RestoreRegions	object
RestoreRegion	array	Las regiones a las que se puede restaurar el archivo de respaldo de datos entre regiones.
	string	La región a la que se puede restaurar el archivo de respaldo de datos entre regiones.	"cn-hangzhou", "cn-shanghai"
PageNumber	integer	El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1.	1
PageRecordCount	integer	El número de archivos de respaldo de datos entre regiones en la página actual.	30
RegionId	string	El ID de región de la instancia.	cn-hangzhou
RequestId	string	El ID de la solicitud.	60912B41-7579-4B5D-B289-8856030F0A6A
StartTime	string	El inicio del intervalo de tiempo a consultar.	2019-05-30T12:10:00Z
TotalRecordCount	integer	El número total de entradas devueltas.	100

Ejemplos

Respuesta exitosa

JSON Formato

{
  "EndTime": "2019-06-15T12:10:00Z",
  "Items": {
    "Item": [
      {
        "BackupEndTime": "2024-03-05T02:23:37Z",
        "BackupMethod": "P",
        "BackupSetScale": 0,
        "BackupSetStatus": 0,
        "BackupStartTime": "2024-03-05T02:22:45Z",
        "BackupType": "F",
        "Category": "HighAvailability",
        "ConsistentTime": "2024-03-05T02:22:54Z",
        "CrossBackupDownloadLink": "http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****",
        "CrossBackupId": 0,
        "CrossBackupRegion": "cn-shanghai",
        "CrossBackupSetFile": "cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb",
        "CrossBackupSetLocation": "oss",
        "CrossBackupSetSize": 5312836,
        "DBInstanceStorageType": "ssd",
        "Engine": "mysql",
        "EngineVersion": "5.6",
        "InstanceId": 0,
        "RestoreRegions": {
          "RestoreRegion": [
            "\"cn-hangzhou\", \"cn-shanghai\""
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 30,
  "RegionId": "cn-hangzhou",
  "RequestId": "60912B41-7579-4B5D-B289-8856030F0A6A",
  "StartTime": "2019-05-30T12:10:00Z",
  "TotalRecordCount": 100
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	ParameterAbsence	Necessary param is absence.
400	InvalidParameters.Format	Specified parameter is not valid.
400	InvalidRegion.Format	Specified Region is not valid.
400	InvalidStartTime.Format	Specified start time is not valid.
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidTime.Format	Specified time 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	CrossBackupNotSupport	Specified region not support cross region backup.
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	InvalidPage.notFound	Page not found.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
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.