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

Consulta los conjuntos de respaldo de clúster para una instancia de clúster fragmentado de ApsaraDB for MongoDB que utiliza discos en la nube.

Descripción de la operación

Para las instancias de clúster fragmentado que utilizan discos en la nube y se crearon antes del 19 de octubre de 2023, debe llamar primero a la operación TransferClusterBackup para convertir los respaldos de fragmento en respaldos de clúster.

Las instancias de clúster fragmentado que utilizan discos en la nube y se crearon después del 19 de octubre de 2023 utilizan respaldos de clúster de forma predeterminada.

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

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.	dds-bp16cb162771****
BackupId	string	No	El ID del respaldo de clúster.	5664****
PageNo	integer	No	El número de la página a devolver. El valor debe ser un entero positivo. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas a devolver en cada página. Valores válidos: 30 (predeterminado) 50 100	30
StartTime	string	No	El inicio del intervalo de tiempo a consultar. Especifique la hora en formato aaaa-MM-ddTHH:mmZ. La hora debe estar en Tiempo Universal Coordinado (UTC). Nota Este parámetro no es válido si especifica el parámetro BackupId.	2019-03-13T12:11Z
EndTime	string	No	El final del intervalo de tiempo a consultar. La hora de finalización debe ser posterior a la hora de inicio. Especifique la hora en formato aaaa-MM-ddTHH:mmZ. La hora debe estar en UTC. Nota Este parámetro no es válido si especifica el parámetro BackupId.	2019-03-14T13:10Z
IsOnlyGetClusterBackUp	boolean	No	Especifica si se debe consultar la información sobre los nodos secundarios en el respaldo de clúster. Valores válidos: true: Devuelve solo la información básica sobre el respaldo de clúster, no la información de respaldo de todos los nodos secundarios. false (predeterminado): Devuelve la información de respaldo de todos los nodos secundarios.	true
SrcRegion	string	No	La región donde reside la instancia. Nota Este parámetro es obligatorio cuando consulta los conjuntos de respaldo de una instancia liberada. Este parámetro es obligatorio cuando consulta respaldos con redundancia geográfica.	cn-hangzhou
DestRegion	string	No	La región donde reside el respaldo con redundancia geográfica. Nota Este parámetro es obligatorio cuando consulta respaldos con redundancia geográfica.	cn-shanghai
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-xxxx
BackupJobId	string	No	El ID del trabajo de respaldo.	775051

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud.	2F42BB4E-461F-5B55-A37C-53B1141C****
MaxResults	integer	El número máximo de entradas devueltas en esta solicitud.	10
PageNumber	integer	El número de página de la página devuelta.	1
PageSize	integer	El número de entradas devueltas por página.	30
ClusterBackups	array<object>	Los detalles de los conjuntos de respaldo de clúster. Un respaldo de clúster contiene los conjuntos de respaldo de todos los nodos.
	array<object>	Los detalles de los conjuntos de respaldo de clúster. Un respaldo de clúster contiene los conjuntos de respaldo de todos los nodos.
IsAvail	integer	Indica si el conjunto de respaldo de clúster es válido. Valores válidos: 1: El conjunto de respaldo de clúster es válido. 0: Los conjuntos de respaldo de los nodos secundarios están incompletos o han fallado.	1
ClusterBackupId	string	El ID del respaldo de clúster.	cb-o8c2ugnxo26kx***
ClusterBackupStatus	string	El estado del respaldo de clúster.	OK
ClusterBackupStartTime	string	La hora en que inició el respaldo de clúster.	2023-10-16T19:33:20Z
ClusterBackupSize	string	El tamaño del conjunto de respaldo de clúster, en bytes.	107374182400
ClusterBackupEndTime	string	La hora en que finalizó el respaldo de clúster.	2023-10-16T19:33:20Z
ClusterBackupMode	string	El modo del respaldo de clúster.	Automated
ExtraInfo	object	La información complementaria. El valor es una cadena con formato JSON.
RegistryFromHistory	string	Indica si el conjunto de respaldo se migró desde un respaldo histórico. Un valor de 1 indica que el respaldo se migró.	1
Backups	array<object>	Los conjuntos de respaldo de cada nodo secundario en el respaldo de clúster.
	array<object>	Los conjuntos de respaldo de cada nodo secundario en el respaldo de clúster.
BackupId	string	El ID del respaldo.	738025367
InstanceName	string	El nombre del fragmento en el clúster de MongoDB.	d-bp16cb162771****
BackupDownloadURL	string	La URL pública desde la cual puede descargar el archivo de respaldo. Si el archivo de respaldo no está disponible para su descarga, se devuelve una cadena vacía.	http://oss.com/xxx
BackupIntranetDownloadURL	string	La URL interna desde la cual puede descargar el archivo de respaldo. Si el archivo de respaldo no está disponible para su descarga, se devuelve una cadena vacía.	http://oss.com/xxx
BackupStartTime	string	La hora en que inició el respaldo. La hora tiene el formato aaaa-MM-ddTHH:mm:ssZ y se muestra en UTC.	2023-10-16T19:33:20Z
BackupEndTime	string	La hora en que finalizó el respaldo. La hora tiene el formato aaaa-MM-ddTHH:mm:ssZ y se muestra en UTC.	2023-10-16T19:33:20Z
BackupSize	string	El tamaño del archivo de respaldo, en bytes.	77544597650
IsAvail	string	Indica si el conjunto de respaldo está disponible. Valores válidos: 0: No disponible. 1: Disponible.	1
BackupStatus	string	El estado del respaldo. Valores válidos: Success: El respaldo fue exitoso. Failed: El respaldo falló.	Success
BackupName	string	El nombre del respaldo.	12345678.tar.gz
ExtraInfo	object	La información sobre el nodo de instancia asociado con el respaldo.
NodeId	string	El ID del nodo.	d-2ze75ab1fa5d****
StorageSize	string	El espacio de almacenamiento del nodo, en MB.	20480
InstanceClass	string	Las especificaciones del nodo.	mdb.shard.4x.large.d
NodeType	string	El tipo de nodo.	db
Progress	string	El progreso del respaldo en porcentaje. Este parámetro se devuelve solo para los respaldos que están en curso.	50
AttachLogStatus	string	El estado del respaldo de registros adjunto. Valores válidos: Init: Inicialización. No_Need: No hay ningún respaldo de registros adjunto disponible. Running: El respaldo de registros adjunto está en curso. Ready: El respaldo de registros adjunto está completo. Failed: El respaldo de registros adjunto falló. Nota Si el valor del parámetro ClusterBackupStatus es OK, solo indica que el respaldo completo fue exitoso. Para una instancia de clúster que tiene habilitado el respaldo de registros, el respaldo de registros adjunto debe estar completo antes de que pueda realizar una restauración a un momento específico o garantizar la consistencia de los datos.	Ready
EngineVersion	string	La versión del motor de base de datos de la instancia cuando se creó el respaldo. 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 caduca el respaldo. La hora tiene el formato aaaa-MM-ddTHH:mm:ssZ y se muestra en UTC. Importante Un valor de "9999-01-01T00:00:00Z" indica que el respaldo se conserva permanentemente.	2025-03-29T03:47:12Z

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "MaxResults": 10,
  "PageNumber": 1,
  "PageSize": 30,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-o8c2ugnxo26kx***",
      "ClusterBackupStatus": "OK",
      "ClusterBackupStartTime": "2023-10-16T19:33:20Z",
      "ClusterBackupSize": "107374182400",
      "ClusterBackupEndTime": "2023-10-16T19:33:20Z",
      "ClusterBackupMode": "Automated",
      "ExtraInfo": {
        "RegistryFromHistory": "1"
      },
      "Backups": [
        {
          "BackupId": "738025367",
          "InstanceName": "d-bp16cb162771****\n",
          "BackupDownloadURL": "http://oss.com/xxx",
          "BackupIntranetDownloadURL": "http://oss.com/xxx",
          "BackupStartTime": "2023-10-16T19:33:20Z",
          "BackupEndTime": "2023-10-16T19:33:20Z",
          "BackupSize": "77544597650",
          "IsAvail": "1",
          "BackupStatus": "Success",
          "BackupName": "12345678.tar.gz",
          "ExtraInfo": {
            "NodeId": "d-2ze75ab1fa5d****",
            "StorageSize": "20480",
            "InstanceClass": "mdb.shard.4x.large.d",
            "NodeType": "db"
          }
        }
      ],
      "Progress": "50",
      "AttachLogStatus": "Ready",
      "EngineVersion": "4.2",
      "BackupExpireTime": "2025-03-29T03:47:12Z"
    }
  ]
}

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.