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.
ListCopyJobs
Devuelve los metadatos de los trabajos de copia.
Sintaxis de la solicitud
GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&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 asociados al ID de cuenta especificado.
Patrón:
^[0-9]{12}$ - ByCompleteAfter
-
Devuelve solo los trabajos de copia completados después de una fecha expresada en formato Unix y horario universal coordinado (UTC).
- ByCompleteBefore
-
Devuelve solo los trabajos de copia completados antes de una fecha expresada en formato Unix y horario universal coordinado (UTC).
- ByCreatedAfter
-
Devuelve solo los trabajos de copia que se crearon después de la fecha especificada.
- ByCreatedBefore
-
Devuelve solo los trabajos de copia que se crearon antes de la fecha especificada.
- ByDestinationVaultArn
-
Un nombre de recurso de Amazon (ARN) que identifica de forma exclusiva un almacén de copias de seguridad de origen desde el que realizar copias; por ejemplo,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. - ByMessageCategory
-
Se trata de un parámetro opcional que se puede utilizar para filtrar los trabajos con un valor MessageCategory que coincida con el valor introducido.
Las cadenas de ejemplo pueden ser
AccessDenied,SUCCESS,AGGREGATE_ALLyINVALIDPARAMETERS.Consulte en Monitorización una lista de cadenas aceptadas.
El valor ANY 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 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 (compatible 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 VMware virtuales
Patrón:
^[a-zA-Z0-9\-\_\.]{1,50}$ -
- ByState
-
Devuelve solo los trabajos de copia que se encuentran en el estado especificado.
Valores válidos:
CREATED | RUNNING | COMPLETED | FAILED | 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 un MaxResults número de artículos, NextToken le permite devolver más artículos de la lista empezando por la ubicación que indique 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
{
"CopyJobs": [
{
"AccountId": "string",
"BackupSizeInBytes": number,
"ChildJobsInState": {
"string" : number
},
"CompletionDate": number,
"CompositeMemberIdentifier": "string",
"CopyJobId": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanName": "string",
"BackupPlanVersion": "string",
"BackupRuleCron": "string",
"BackupRuleId": "string",
"BackupRuleName": "string",
"BackupRuleTimezone": "string"
},
"CreationDate": number,
"DestinationBackupVaultArn": "string",
"DestinationEncryptionKeyArn": "string",
"DestinationRecoveryPointArn": "string",
"DestinationRecoveryPointLifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"DestinationVaultLockState": "string",
"DestinationVaultType": "string",
"IamRoleArn": "string",
"IsParent": boolean,
"MessageCategory": "string",
"NumberOfChildJobs": number,
"ParentJobId": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"SourceRecoveryPointArn": "string",
"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.
- CopyJobs
-
Una matriz de estructuras que contiene metadatos sobre trabajos de copia devueltos en formato JSON.
Tipo: matriz de objetos CopyJob
- NextToken
-
El siguiente elemento que sigue a una lista parcial de elementos devueltos. Por ejemplo, si se solicita que se devuelva el MaxResults número de NextToken artículos, podrás devolver más artículos de la lista empezando por la ubicación que indique 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.
- Context
- Type
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
- Context
- Type
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
