DescribeClusterBackupList - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Consulta la lista de copias de seguridad de una instancia de clúster de Tair (compatible con Redis OSS).

Descripción de la operación

Esta API solo es aplicable a instancias nativas de la nube.

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

kvstore:DescribeClusterBackupList

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-zhangjiakou
InstanceId	string	Sí	El ID de la instancia.	r-t4nj72oug5r5646qog
ClusterBackupId	string	No	El ID del conjunto de copias de seguridad.	cb-hyxdof5x9kqbtust
PageSize	integer	No	El número de entradas por página. Valores válidos: 30 50 100 200 300 5 10 15 20	30
PageNumber	integer	No	El número de página.	1
StartTime	string	Sí	El inicio del intervalo de tiempo a consultar. Especifique la hora en formato ISO 8601 aaaa-MM-ddTHH:mmZ. La hora debe estar en UTC.	2024-06-28T08:26Z
EndTime	string	Sí	El fin del intervalo de tiempo a consultar. Especifique la hora en formato ISO 8601 aaaa-MM-ddTHH:mmZ. La hora debe estar en UTC. La hora de finalización debe ser posterior a la hora de inicio.	2024-07-01T09:26Z
NoShardBackup	string	No	Especifica si se debe mostrar la información del conjunto de copias de seguridad para los fragmentos de la instancia. true: no muestra la información del conjunto de copias de seguridad para los fragmentos de la instancia. false (predeterminado): muestra la información del conjunto de copias de seguridad para los fragmentos de la instancia. Valores válidos: True False	True

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de la respuesta.
RequestId	string	El ID de la solicitud.	C009DA42-3B19-5B81-963D-1509DE2408DD
MaxResults	integer	El número máximo de entradas devueltas.	4
PageNumber	integer	El número de página.	1
PageSize	integer	El número máximo de entradas devueltas por página.	30
FullStorageSize	integer	El tamaño del archivo de copia de seguridad completa de la instancia. Unidad: bytes. Las copias de seguridad completas provienen de copias de seguridad programadas, copias de seguridad manuales y copias de seguridad generadas durante el análisis de caché. Nota El valor de este parámetro es independiente del número y tamaño de los conjuntos de copias de seguridad devueltos. En su lugar, representa el tamaño de todas las copias de seguridad completas válidas de la instancia.	1000
LogStorageSize	integer	El tamaño del archivo de copia de seguridad de registros de la instancia. Unidad: bytes. Este parámetro solo es válido cuando la función flashback está habilitada. Nota El valor de este parámetro es independiente del número y tamaño de los conjuntos de copias de seguridad devueltos. En su lugar, representa el tamaño de todas las copias de seguridad de registros válidas de la instancia.	5000
FreeSize	integer	Este parámetro no surte efecto. Ignore este parámetro.	100000
ClusterBackups	array<object>	Los conjuntos de copias de seguridad de la instancia. Una copia de seguridad contiene los conjuntos de copias de seguridad de todos los fragmentos de la instancia.
	array<object>	El conjunto de copias de seguridad de la instancia. Una copia de seguridad contiene los conjuntos de copias de seguridad de todos los fragmentos de la instancia.
IsAvail	integer	Indica si el conjunto de copias de seguridad es válido. Un valor de 0 indica que las copias de seguridad a nivel de fragmento fallaron o no se han completado.	1
ClusterBackupId	string	El ID del conjunto de copias de seguridad.	cb-zmdqj2m3xyxjtdt0
ClusterBackupStatus	string	El estado del conjunto de copias de seguridad. OK RUNNING Failed	OK
ClusterBackupSize	string	El tamaño del conjunto de copias de seguridad.	2048
ClusterBackupStartTime	string	La hora de inicio de la copia de seguridad.	2024-01-10T17:21:25Z
ClusterBackupEndTime	string	La hora de finalización de la copia de seguridad.	2024-01-10T17:21:55Z
ClusterBackupMode	string	El modo de copia de seguridad.	Automated
ShardClassMemory	integer	El tamaño de memoria de un solo fragmento durante una copia de seguridad completa. Unidad: MB.	1024
Backups	array<object>	Los conjuntos de copias de seguridad de todos los fragmentos de la instancia.
	array<object>	El conjunto de copias de seguridad consultado.
BackupId	string	El ID del archivo de copia de seguridad.	514645788
InstanceName	string	El nombre de la instancia.	r-bp1y4is8svonly****-db-0
BackupDownloadURL	string	La URL de descarga pública del archivo de copia de seguridad.	http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
BackupIntranetDownloadURL	string	La URL de descarga interna del archivo de copia de seguridad. Nota Puede utilizar esta URL para descargar el archivo de copia de seguridad desde una instancia de Elastic Compute Service (ECS) que esté conectada a la instancia de Tair (compatible con Redis OSS). La instancia de ECS debe residir en la misma red privada virtual (VPC) que la instancia de Tair (compatible con Redis OSS).	http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
RecoverConfigMode	string	Este parámetro no surte efecto. Ignore este parámetro.	null
BackupStartTime	string	La hora de inicio de la copia de seguridad. La hora sigue el estándar ISO 8601 en el formato aaaa-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2024-01-09T17:21:30Z
BackupEndTime	string	La hora de finalización de la copia de seguridad. La hora sigue el estándar ISO 8601 en el formato aaaa-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2024-01-09T17:21:57
BackupSize	string	El tamaño del archivo de copia de seguridad. Unidad: bytes.	1024
IsAvail	string	Indica si el conjunto de copias de seguridad está disponible. Valores válidos: 0: no disponible 1: disponible	1
BackupStatus	string	El estado de la copia de seguridad. Valores válidos: OK ERROR	OK
BackupName	string	El nombre de la copia de seguridad.	hins100322105_data_20240110012135.rdb
Engine	string	El motor de base de datos. El valor devuelto es redis.	redis
ExtraInfo	object	La información adicional.
CustinsDbVersion	string	La versión del motor.	5.0
Progress	string	El progreso de la copia de seguridad. El sistema solo muestra el progreso de las tareas de copia de seguridad en ejecución.	100%
ExpectExpireTime	string	El tiempo de vida (TTL) del conjunto de copias de seguridad, en formato aaaa-MM-ddTHH:mmZ (hora UTC).	2025-06-01T21:51:22Z

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "C009DA42-3B19-5B81-963D-1509DE2408DD",
  "MaxResults": 4,
  "PageNumber": 1,
  "PageSize": 30,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-zmdqj2m3xyxjtdt0",
      "ClusterBackupStatus": "OK",
      "ClusterBackupSize": "2048",
      "ClusterBackupStartTime": "2024-01-10T17:21:25Z",
      "ClusterBackupEndTime": "2024-01-10T17:21:55Z",
      "ClusterBackupMode": "Automated",
      "ShardClassMemory": 1024,
      "Backups": [
        {
          "BackupId": "514645788",
          "InstanceName": "r-bp1y4is8svonly****-db-0",
          "BackupDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "BackupIntranetDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "RecoverConfigMode": "null",
          "BackupStartTime": "2024-01-09T17:21:30Z",
          "BackupEndTime": "2024-01-09T17:21:57",
          "BackupSize": "1024",
          "IsAvail": "1",
          "BackupStatus": "OK",
          "BackupName": "hins100322105_data_20240110012135.rdb",
          "Engine": "redis",
          "ExtraInfo": {
            "CustinsDbVersion": "5.0"
          }
        }
      ],
      "Progress": "100%",
      "ExpectExpireTime": "2025-06-01T21:51:22Z"
    }
  ]
}

Códigos de error

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.