DescribeBackups - PolarDB - Centro de documentación de Alibaba Cloud

Consulta la información de respaldo de un clúster de PolarDB.

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

polardb:DescribeBackups

get

*Backup

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBClusterId	string	Sí	El ID del clúster.	pc-****************
BackupId	string	No	El ID del respaldo.	11111111
BackupStatus	string	No	El estado del respaldo. Valores válidos: Success: el respaldo se completó. Failed: el respaldo falló.	Success
BackupMode	string	No	El modo de respaldo. Valores válidos: Automated: respaldo automático. Manual: respaldo manual.	Automated
StartTime	string	Sí	El inicio del intervalo de tiempo a consultar. Especifique la hora en formato `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-14T00:00Z
EndTime	string	Sí	El fin del intervalo de tiempo a consultar. La hora de finalización debe ser posterior a la hora de inicio. Especifique la hora en formato `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-16T00:00Z
BackupRegion	string	No	La región de destino para los respaldos entre regiones. Nota Actualmente, solo PolarDB for MySQL admite este parámetro.	cn-hangzhou
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. Establezca el valor en un número entero mayor que 0 y que no exceda el valor máximo del tipo de datos Integer. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalRecordCount	string	El número total de registros.	1
PageRecordCount	string	El número de registros en la página actual.	1
RequestId	string	El ID de la solicitud.	24A1990B-4F6E-482B-B8CB-75C612******
PageNumber	string	El número de página.	1
Items	object
Backup	array<object>	Los detalles del conjunto de respaldo.
	object
BackupSetSize	string	El tamaño del archivo de respaldo. Unidad: bytes. Nota Dado que los bloques de datos se comparten entre instantáneas, el espacio liberado después de eliminar un respaldo de instantánea es mucho menor que el tamaño del archivo de respaldo. Para obtener más información, consulte Preguntas frecuentes sobre respaldos.	4639948800
ConsistentTime	string	El punto en el tiempo de la instantánea consistente. El valor es una marca de tiempo UNIX. Unidad: segundos.	1605425407
BackupStatus	string	El estado del respaldo. Valores válidos: Success: el respaldo se completó. Failed: el respaldo falló.	Success
BackupType	string	El tipo de respaldo. Solo se admiten respaldos completos. El valor está fijado como FullBackup.	FullBackup
BackupStartTime	string	La hora de inicio de este respaldo (UTC).	2020-11-15T07:30:05Z
ExpectExpireTime	string	La hora de caducidad esperada del conjunto de respaldo. Este parámetro solo se admite en instancias con el respaldo disperso habilitado.	2022-10-24T08:13:23Z
ExpectExpireType	string	El tipo de caducidad esperada del conjunto de respaldo. Este parámetro solo se admite en instancias con el respaldo disperso habilitado. Valores válidos: NEVER : NEVER. EXPIRED : EXPIRED. DELAY : DELAY.	EXPIRED
IsAvail	string	Indica si el conjunto de respaldo está disponible. Valores válidos: 0: no disponible. 1: disponible.	0
BackupEndTime	string	La hora de finalización de este respaldo (UTC).	2020-11-15T07:30:20Z
BackupId	string	El ID del respaldo.	61*******
DBClusterId	string	El ID del clúster.	pc-****************
BackupsLevel	string	El nivel del conjunto de respaldo. Valores válidos: Level-1: respaldo de nivel 1. Level-2: respaldo de nivel 2.	Level-1
BackupMode	string	El modo de respaldo. Valores válidos: Automated: respaldo automático. Manual: respaldo manual.	Automated
BackupMethod	string	El método de respaldo de datos. Solo se admiten respaldos de instantánea. El valor está fijado como Snapshot.	Snapshot
TableRestoreMetaStatus	string
Comment	string
TotalLevel2BackupSize	string	El tamaño total de los respaldos de nivel 2 en la región especificada. Unidad: bytes. Nota Solo se admiten los tipos de almacenamiento PSL4 y PSL5. Solo se admiten clústeres con la función de respaldo de nivel 2 habilitada. Si no se devuelve este parámetro, el tamaño del respaldo de nivel 2 es 0.	4639948800

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "4639948800",
        "ConsistentTime": "1605425407",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-11-15T07:30:05Z",
        "ExpectExpireTime": "2022-10-24T08:13:23Z",
        "ExpectExpireType": "EXPIRED\u0000\u0000",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot",
        "TableRestoreMetaStatus": "",
        "Comment": ""
      }
    ]
  },
  "TotalLevel2BackupSize": "4639948800"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidBackupStatus.Malformed	The specified parameter BackupStatus is not valid.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

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.