As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeScanJob
Retorna os detalhes do trabalho de digitalização para a ScanJob ID especificada.
Sintaxe da Solicitação
GET /scan/jobs/ScanJobId HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- ScanJobId
-
Identifica de forma exclusiva uma solicitação para AWS Backup escanear um recurso.
Obrigatório: sim
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
HTTP/1.1 200
Content-type: application/json
{
"AccountId": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"IamRoleArn": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanId": "string",
"ScanJobId": "string",
"ScanMode": "string",
"ScannerRoleArn": "string",
"ScanResult": {
"ScanResultStatus": "string"
},
"State": "string",
"StatusMessage": "string"
}Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- AccountId
-
Retorna o ID da conta que é proprietária do trabalho de digitalização.
Padrão:
^[0-9]{12}$Tipo: string
- BackupVaultArn
-
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup; por exemplo,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultTipo: string
- BackupVaultName
-
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes exclusivos da conta usada para criá-los e da AWS região em que foram criados.
Padrão:
^[a-zA-Z0-9\-\_\.]{2,50}$Tipo: string
- CompletionDate
-
A data e hora em que um índice de backup concluiu a criação, em formato Unix e Tempo Universal Coordenado (UTC). O valor de
CompletionDatetem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: carimbo de data/hora
- CreatedBy
-
Contém informações de identificação sobre a criação de uma tarefa de verificação, incluindo o plano de backup e a regra que iniciaram a verificação.
Tipo: objeto ScanJobCreator
- CreationDate
-
A data e hora em que um índice de backup concluiu a criação, em formato Unix e Tempo Universal Coordenado (UTC). O valor de
CreationDatetem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: carimbo de data/hora
- IamRoleArn
-
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo,
arn:aws:iam::123456789012:role/S3Access.Tipo: string
- MalwareScanner
-
O mecanismo de escaneamento usado para o trabalho de escaneamento correspondente. No momento, somente
GUARDUTYé compatível.Tipo: string
Valores válidos:
GUARDDUTY - RecoveryPointArn
-
Um ARN que identifica de forma exclusiva o ponto de recuperação de destino para digitalização.; por exemplo,.
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45Tipo: string
- ResourceArn
-
Um ARN que identifica de forma exclusiva o recurso de origem do ARN do ponto de recuperação correspondente.
Tipo: string
- ResourceName
-
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
- ResourceType
-
O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS).
Padrão:
^[a-zA-Z0-9\-\_\.]{1,50}$Tipo: string
Valores válidos:
EBS | EC2 | S3 - ScanBaseRecoveryPointArn
-
Um ARN que identifica de forma exclusiva o ponto de recuperação básico para digitalização. Esse campo só será preenchido quando um trabalho de verificação incremental tiver ocorrido.
Tipo: string
- ScanId
-
O ID de escaneamento gerado pela Amazon GuardDuty para a solicitação de Scan Job ID correspondente de AWS Backup.
Tipo: string
- ScanJobId
-
O ID do trabalho de digitalização que identificou de forma exclusiva a solicitação para. AWS Backup
Tipo: string
- ScanMode
-
Especifica o tipo de escaneamento usado para o trabalho de escaneamento.
Tipo: string
Valores válidos:
FULL_SCAN | INCREMENTAL_SCAN - ScannerRoleArn
-
Especifica a função do IAM do scanner que o ARN usa para o trabalho de digitalização.
Tipo: string
- ScanResult
-
Contém o
ScanResultsStatuspara o trabalho de digitalização e devoluçõesTHREATS_FOUNDouNO_THREATS_FOUNDpara trabalhos concluídos.Tipo: objeto ScanResultInfo
- State
-
O estado atual de um trabalho de digitalização.
Tipo: string
Valores válidos:
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING - StatusMessage
-
Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.
Tipo: string
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
- Context
- Type
Código de status HTTP: 400
- MissingParameterValueException
-
Indica que um parâmetro necessário está ausente.
- Context
- Type
Código de status HTTP: 400
- ResourceNotFoundException
-
Um recurso necessário para a ação não existe.
- Context
- Type
Código de status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
- Context
- Type
Código de status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
