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

Consulta las instancias para las que está habilitada la función de respaldo entre regiones en una región y la configuración de respaldo entre regiones de dichas instancias.

Descripción de la operación

Motores de base de datos compatibles

MySQL
PostgreSQL
SQL Server

Referencias

Nota

Antes de llamar a esta operación, lea los siguientes temas y asegúrese de comprender completamente los requisitos previos y el impacto de esta operación.

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

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

get

*DBInstance.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región.	cn-hangzhou
DBInstanceId	string	No	El ID de la instancia. Se permiten hasta 30 ID de instancias en una sola solicitud. Si introduce más de un ID de instancia, sepárelos con comas (,).	rm-uf6wjk5****
PageSize	integer	No	El número de entradas a devolver por página. Valor predeterminado: 30.	30
PageNumber	integer	No	El número de la página a devolver. Valores válidos: cualquier entero positivo distinto de cero. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
Items	object
Item	array<object>	La configuración de respaldo entre regiones.
	object
BackupEnabled	string	El estado de la función de respaldo entre regiones en la instancia. Valores válidos: Disable Enable	Enable
BackupEnabledTime	string	La hora en que se habilitó el respaldo entre regiones en la instancia. La hora sigue el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2019-06-12T05:44:21Z
CrossBackupRegion	string	El ID de la región de destino donde se almacena el archivo de respaldo entre regiones.	cn-shanghai
CrossBackupType	string	La política que se utiliza para guardar los archivos de respaldo entre regiones de la instancia. Valor predeterminado: 1. El valor 1 indica que se guardan todos los archivos de respaldo entre regiones.	1
DBInstanceDescription	string	El nombre de la instancia. Debe tener entre 2 y 256 caracteres de longitud. El valor puede contener letras, dígitos, guiones bajos (_) y guiones (-), y debe comenzar con una letra. Nota El valor no puede comenzar con http:// o https://.	testdb
DBInstanceId	string	El ID de la instancia.	rm-uf6wjk5****
DBInstanceStatus	string	El estado de la instancia. Para obtener más información, consulte Estados de las instancias.	Running
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
LockMode	string	El estado de bloqueo de la instancia. Valores válidos: Unlock: La instancia no está bloqueada. ManualLock: La instancia está bloqueada manualmente. LockByExpiration: La instancia se bloquea automáticamente después de su vencimiento. LockByRestoration: La instancia se bloquea automáticamente antes de revertirse. LockByDiskQuota: La instancia se bloquea automáticamente porque su capacidad de almacenamiento se ha agotado y la instancia es inaccesible.	Unlock
LogBackupEnabled	string	El estado de la función de respaldo de registros entre regiones en la instancia. Valores válidos: Disable Enable	Enable
LogBackupEnabledTime	string	La hora en que se habilitó la función de respaldo de registros entre regiones en la instancia. La hora sigue el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2019-06-12T05:44:21Z
RetentType	integer	La política que se utiliza para retener los archivos de respaldo entre regiones de la instancia. Los respaldos entre regiones solo pueden retenerse según el período de retención especificado. Valor predeterminado: 1.	1
Retention	integer	El número de días durante los cuales se retienen los archivos de respaldo entre regiones de la instancia. Valores válidos: 7 a 1825.	15
ItemsNumbers	integer	El número total de elementos devueltos para la configuración de respaldo entre regiones.	1
PageNumber	integer	El número de página. Las páginas comienzan desde la página 1. Valor predeterminado: 1.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 30.	30
RegionId	string	El ID de la región.	cn-hangzhou
RequestId	string	El ID de la solicitud.	33517002-182D-40BE-93EC-610BD3381045
TotalRecords	integer	El número total de entradas devueltas.	100

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Items": {
    "Item": [
      {
        "BackupEnabled": "Enable",
        "BackupEnabledTime": "2019-06-12T05:44:21Z",
        "CrossBackupRegion": "cn-shanghai",
        "CrossBackupType": "1",
        "DBInstanceDescription": "testdb",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceStatus": "Running",
        "Engine": "MySQL",
        "EngineVersion": "5.6",
        "LockMode": "Unlock",
        "LogBackupEnabled": "Enable",
        "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
        "RetentType": 1,
        "Retention": 15
      }
    ]
  },
  "ItemsNumbers": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "RegionId": "cn-hangzhou",
  "RequestId": "33517002-182D-40BE-93EC-610BD3381045",
  "TotalRecords": 100
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidParameters.Format	Specified parameter is not valid.
400	InvalidRegion.Format	Specified Region 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	IncorrectDBInstanceEngine	Current DB Instance engine 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	InvalidPage.notFound	Page not found.
404	InvalidUser.NotFound	Specified user does not exist.
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.