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á.
ListSearchJobs
Essa operação retorna uma lista de trabalhos de pesquisa pertencentes a uma conta.
Sintaxe da Solicitação
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- ByStatus
-
Inclua esse parâmetro para filtrar a lista pelo status do trabalho de pesquisa.
Valores Válidos:
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED - MaxResults
-
O número máximo de itens da lista de recursos a serem retornados.
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.
- NextToken
-
O próximo item após uma lista parcial dos trabalhos de pesquisa retornados.
Por exemplo, se for feita uma solicitação para retornar o
MaxResultsnúmero deNextTokenbackups, você poderá retornar mais itens em sua lista começando pelo local apontado pelo próximo token.
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SearchJobs": [
{
"CompletionTime": number,
"CreationTime": number,
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "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.
- NextToken
-
O próximo item após uma lista parcial dos backups retornados incluídos em um trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o
MaxResultsnúmero deNextTokenbackups, você poderá retornar mais itens em sua lista começando pelo local apontado pelo próximo token.Tipo: String
- SearchJobs
-
Os trabalhos de pesquisa na lista, com detalhes dos trabalhos de pesquisa retornados.
Tipo: matriz de objetos SearchJobSummary
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 realizar essa 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
-
Repita a chamada após alguns segundos.
Código de status HTTP: 500
- ThrottlingException
-
A solicitação foi negada devido ao controle de limitação.
- message
-
A solicitação não foi bem-sucedida devido à limitação da solicitação.
- quotaCode
-
Esse é o código exclusivo do serviço de origem com a cota.
- retryAfterSeconds
-
Repita a chamada 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 satisfaz as restrições especificadas por um serviço.
- message
-
A entrada não satisfaz as 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 uma das linguagens específicas AWS SDKs, consulte o seguinte:
