Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
ListBackupJobs
Devuelve una lista de los trabajos de copia de seguridad existentes para una cuenta autenticada durante los últimos 30 días. Para un periodo de tiempo más prolongado, considere la posibilidad de utilizar estas herramientas de monitorización.
Sintaxis de la solicitud
GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- ByAccountId
-
El ID de la cuenta desde la que se van a enumerar los trabajos. Devuelve solo los trabajos de copia de seguridad asociados al ID de cuenta especificado.
Si se utiliza desde una cuenta de administración de AWS Organizations, al pasar
*se devuelven todos los trabajos de la organización.Patrón:
^[0-9]{12}$ - ByBackupVaultName
-
Devuelve solo los trabajos de copia de seguridad que se almacenarán en el almacén de copias de seguridad especificado. Los almacenes de copia de seguridad se identifican con nombres que son exclusivos de la cuenta usada para crearlos y de la región de AWS donde se crearon.
Patrón:
^[a-zA-Z0-9\-\_]{2,50}$ - ByCompleteAfter
-
Devuelve solo los trabajos de copia de seguridad completados después de una fecha expresada en formato Unix y horario universal coordinado (UTC).
- ByCompleteBefore
-
Devuelve solo los trabajos de copia de seguridad completados antes de una fecha expresada en formato Unix y horario universal coordinado (UTC).
- ByCreatedAfter
-
Devuelve solo los trabajos de copia de seguridad que se crearon después de la fecha especificada.
- ByCreatedBefore
-
Devuelve solo los trabajos de copia de seguridad que se crearon antes de la fecha especificada.
- ByMessageCategory
-
Es un parámetro opcional que se puede utilizar para filtrar los trabajos con una MessageCategory que coincide con el valor introducido.
Las cadenas de ejemplo pueden ser
AccessDenied,SUCCESS,AGGREGATE_ALLyInvalidParameters.Vista Monitorización
El comodín () devuelve el recuento de todas las categorías de mensajes.
AGGREGATE_ALLsuma los recuentos de trabajos de todas las categorías de mensajes y devuelve la suma. - ByParentJobId
-
Se trata de un filtro para enumerar los trabajos secundarios (anidados) en función del ID del trabajo principal.
- ByResourceArn
-
Devuelve solo los trabajos de copia de seguridad que coinciden con el nombre de recurso de Amazon (ARN) del recurso especificado.
- ByResourceType
-
Devuelve únicamente los trabajos de copia de seguridad de los recursos especificados:
-
Aurorapara Amazon Aurora -
CloudFormationpara AWS CloudFormation -
DocumentDBpara Amazon DocumentDB (con compatibilidad con MongoDB) -
DynamoDBpara Amazon DynamoDB -
EBSpara Amazon Elastic Block Store (EBS) -
EC2para Amazon Elastic Compute Cloud -
EFSpara Amazon Elastic File System -
FSxpara Amazon FSx -
Neptunepara Amazon Neptune -
RDSpara Amazon Relational Database Service -
Redshiftpara Amazon Redshift -
S3para Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2para bases de datos de SAP HANA en instancias de Amazon Elastic Compute Cloud -
Storage Gatewaypara AWS Storage Gateway -
Timestreampara Amazon Timestream -
VirtualMachinepara máquinas virtuales de VMware
Patrón:
^[a-zA-Z0-9\-\_\.]{1,50}$ -
- ByState
-
Devuelve solo los trabajos de copia de seguridad que se encuentran en el estado especificado.
Completed with issueses un estado que solo se encuentra en la consola de AWS Backup. En el caso de la API, este estado se refiere a los trabajos con un estado deMessageCategoryy unaSUCCESScon un valor distinto deCOMPLETED; es decir, el estado se ha completado pero genera un mensaje de estado.Para obtener el recuento de trabajos de
Completed with issues, ejecute dos solicitudes GET y reste el segundo número, más pequeño:GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
Valores válidos:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL - MaxResults
-
Número máximo de elementos que se van a devolver.
Rango válido: valor mínimo de 1. Valor máximo de 1000.
- NextToken
-
El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el número de elementos
MaxResults,NextTokenpermite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.
Cuerpo de la solicitud
La solicitud no tiene un cuerpo de la solicitud.
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"BackupJobs": [
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "string",
"StatusMessage": "string"
}
],
"NextToken": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- BackupJobs
-
Una matriz de estructuras que contiene metadatos sobre trabajos de copia de seguridad devueltos en formato JSON.
Tipo: matriz de objetos BackupJob
- NextToken
-
El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el número de elementos
MaxResults,NextTokenpermite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
