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á.
GetSearchJob
Essa operação recupera metadados de um trabalho de pesquisa, incluindo seu andamento.
Sintaxe da Solicitação
GET /search-jobs/SearchJobIdentifier HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- SearchJobIdentifier
-
String exclusiva obrigatória que especifica o trabalho de pesquisa.
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
{
"CompletionTime": number,
"CreationTime": number,
"CurrentSearchProgress": {
"ItemsMatchedCount": number,
"ItemsScannedCount": number,
"RecoveryPointsScannedCount": number
},
"EncryptionKeyArn": "string",
"ItemFilters": {
"EBSItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"FilePaths": [
{
"Operator": "string",
"Value": "string"
}
],
"LastModificationTimes": [
{
"Operator": "string",
"Value": number
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
]
}
],
"S3ItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"ETags": [
{
"Operator": "string",
"Value": "string"
}
],
"ObjectKeys": [
{
"Operator": "string",
"Value": "string"
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
],
"VersionIds": [
{
"Operator": "string",
"Value": "string"
}
]
}
]
},
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "string",
"SearchScope": {
"BackupResourceArns": [ "string" ],
"BackupResourceCreationTime": {
"CreatedAfter": number,
"CreatedBefore": number
},
"BackupResourceTags": {
"string" : "string"
},
"BackupResourceTypes": [ "string" ],
"SourceResourceArns": [ "string" ]
},
"SearchScopeSummary": {
"TotalItemsToScanCount": number,
"TotalRecoveryPointsToScanCount": number
},
"Status": "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.
- CompletionTime
-
A data e hora em que um trabalho de pesquisa foi concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de
CompletionTimetem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: Timestamp
- CreationTime
-
A data e a hora em que um trabalho de pesquisa foi criado, em formato Unix e Tempo Universal Coordenado (UTC). O valor de
CompletionTimetem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.Tipo: Timestamp
- CurrentSearchProgress
-
Retorna números que representam BackupsScannedCount, ItemsScanned e ItemsMatched.
Tipo: objeto CurrentSearchProgress
- EncryptionKeyArn
-
A chave de criptografia para o trabalho de pesquisa especificado.
Exemplo: :
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.Tipo: String
- ItemFilters
-
Os filtros de itens representam todas as propriedades do item de entrada especificadas quando a pesquisa foi criada.
Tipo: objeto ItemFilters
- Name
-
Nome retornado do trabalho de pesquisa especificado.
Tipo: String
- SearchJobArn
-
A string exclusiva que identifica o nome do recurso da Amazon (ARN) do trabalho de pesquisa especificado.
Tipo: String
- SearchJobIdentifier
-
A string exclusiva que identifica o trabalho de pesquisa especificado.
Tipo: String
- SearchScope
-
O escopo da pesquisa consiste em todas as propriedades de backup inseridas em uma pesquisa.
Tipo: objeto SearchScope
- SearchScopeSummary
-
Resumo retornado do escopo do trabalho de pesquisa especificado, incluindo:
-
TotalBackupsToScanCount, o número de pontos de recuperação retornados pela pesquisa.
-
TotalItemsToScanCount, o número de itens retornados pela pesquisa.
Tipo: objeto SearchScopeSummary
-
- Status
-
O status atual do trabalho de pesquisa especificado.
Um trabalho de pesquisa pode ter um destes status:
RUNNING;COMPLETED;STOPPED;FAILED;TIMED_OUT; ouEXPIRED.Tipo: String
Valores Válidos:
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED - StatusMessage
-
Uma mensagem de status será retornada para um trabalho de pesquisa com um status de
ERROREDou um status de trabalhosCOMPLETEDcom problemas.Por exemplo, uma mensagem pode dizer que uma pesquisa continha pontos de recuperação que não puderam ser verificados devido a um problema de permissões.
Tipo: String
Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte Erros comuns.
- AccessDeniedException
-
Você não tem acesso suficiente para executar esta ação.
- message
-
O usuário não tem acesso suficiente para executar esta ação.
Código de Status HTTP: 403
- InternalServerException
-
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
- message
-
Erro inesperado durante o processamento da solicitação.
- retryAfterSeconds
-
Tente fazer a chamada novamente após alguns segundos.
Código de Status HTTP: 500
- ResourceNotFoundException
-
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
- message
-
A solicitação faz referência a um recurso que não existe.
- resourceId
-
Identificador hipotético do recurso afetado.
- resourceType
-
Tipo hipotético do recurso afetado.
Código de Status HTTP: 404
- ThrottlingException
-
A solicitação foi negada devido à limitação da solicitação.
- message
-
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
- quotaCode
-
Esse é o código exclusivo do serviço de origem com a cota.
- retryAfterSeconds
-
Tente fazer a chamada novamente após alguns segundos.
- serviceCode
-
Esse é o código exclusivo do serviço de origem.
Código de Status HTTP: 429
- ValidationException
-
A entrada não atende às restrições especificadas por um serviço.
- message
-
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
Consulte Também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
