DescribeBackups - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Consulta la lista de backups de una instancia de ApsaraDB for MongoDB.

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

dds:DescribeBackups

get

*Instance

acs:dds:{#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. Nota Si establece este parámetro en el ID de una instancia de clúster fragmentado, también debe especificar el parámetro NodeId.	dds-bp1a7009eb24****
NodeId	string	No	El ID de instancia del nodo de fragmento en la instancia de clúster fragmentado. Nota Este parámetro es obligatorio si establece el parámetro DBInstanceId en el ID de una instancia de clúster fragmentado.	d-bp128a003436****
BackupId	string	No	El ID de la instancia. Si establece el parámetro DBInstanceId en el ID de una instancia de clúster fragmentado, el número de ID de instancias es igual al número de nodos de fragmento. Separe varios ID de instancias con comas (,).	2072**,2072,2072**
PageNumber	integer	No	El número de página. El valor debe ser un entero positivo que no exceda el valor máximo del tipo de datos Integer. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 (predeterminado) 50 100 Valores válidos: 30 : 30 entradas por página. 50 : 50 entradas por página. 100 : 100 entradas por página.	30
StartTime	string	No	El inicio del intervalo de tiempo que se va a consultar. Especifique la hora en el formato yyyy-MM-ddTHH:mmZ (UTC). Nota Este parámetro no es válido si se especifica BackupId.	2022-01-13T13:00Z
EndTime	string	No	El fin del intervalo de tiempo que se va a consultar. La hora de fin debe ser posterior a la hora de inicio. Especifique la hora en el formato yyyy-MM-ddTHH:mmZ (UTC). Nota Este parámetro no es válido si se especifica BackupId.	2022-01-14T13:00Z
SrcRegion	string	No	La región donde reside la instancia. Nota Este parámetro es obligatorio para restaurar una instancia eliminada. Este parámetro es obligatorio para backups de georredundancia.	cn-beijing
DestRegion	string	No	La región donde reside el backup. Nota Este parámetro es obligatorio para backups de georredundancia.	cn-hangzhou
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-xxxx
BackupJobId	string	No	El ID de la tarea de backup.	775051

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La información de backup de la instancia.
TotalCount	integer	El número total de backups.	1
RequestId	string	El ID de la solicitud.	275D43C3-F12F-5224-B375-************
PageSize	integer	El número de entradas por página. Valores válidos: 30 (predeterminado) 50 100	30
PageNumber	integer	El número de página.	1
Backups	object
Backup	array<object>	La lista de detalles de los archivos de backup.
	object	La lista de detalles de los archivos de backup.
BackupStatus	string	El estado del backup. Valores válidos: Success: el backup se realizó correctamente. Failed: el backup falló.	Success
BackupType	string	El tipo de backup. Valores válidos: FullBackup: backup completo. IncrementalBackup: backup incremental.	FullBackup
BackupStartTime	string	La hora de inicio del backup. La hora está en el formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	La URL de descarga interna del archivo de backup. Nota Puede usar esta URL para descargar el archivo de backup desde una instancia de ECS que esté en la misma red que la instancia de ApsaraDB for MongoDB.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=*******************&Signature=****************************&Region=cn-hangzhou
BackupSize	integer	El tamaño del archivo de backup. Unidad: bytes.	6168576
BackupDownloadURL	string	La URL de descarga pública del archivo de backup. Se devuelve una cadena vacía si el archivo de backup no está disponible actualmente para su descarga.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=********************&Signature=****************************&Region=cn-hangzhou
BackupMode	string	El modo de backup. Valores válidos: Automated: backup automático. Manual: backup manual.	Automated
BackupEndTime	string	La hora de fin del backup. La hora está en el formato yyyy-MM-ddTHH:mm:ssZ (UTC).	2022-01-14T03:57:34Z
BackupId	string	El ID del backup.	32102****
BackupDBNames	string	El nombre de la base de datos de la que se realizó el backup.	database
BackupMethod	string	El método de backup. Valores válidos: Snapshot: backup de instantánea. Physical: backup físico. Logical: backup lógico.	Physical
BackupJobId	string	El ID de la tarea de backup.	1123xxxx
BackupName	string	El nombre del conjunto de backups. Este parámetro no es válido actualmente.	12345678.tar.gz
BackupScale	string	La granularidad del backup. Este parámetro no es válido actualmente.	DBInstance
IsAvail	boolean	Indica si el conjunto de backups está disponible. Valores válidos: 0: no disponible. 1: disponible.	1
EngineVersion	string	La versión del motor de base de datos de la instancia cuando se creó el backup. Valores válidos: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	La hora en que expira el backup. La hora está en el formato yyyy-MM-ddTHH:mm:ssZ (UTC). Importante "9999-01-01T00:00:00Z" indica retención a largo plazo (LTR).	2025-08-30T09:49:11Z

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "RequestId": "275D43C3-F12F-5224-B375-************",
  "PageSize": 30,
  "PageNumber": 1,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-01-14T03:56:17Z",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": "32102****",
        "BackupDBNames": "database",
        "BackupMethod": "Physical",
        "BackupJobId": "1123xxxx",
        "BackupName": "12345678.tar.gz",
        "BackupScale": "DBInstance",
        "IsAvail": true,
        "EngineVersion": "4.2",
        "BackupExpireTime": "2025-08-30T09:49:11Z"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The Specified parameter StartTime or EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

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.