ListSearchJobs
이 작업은 계정에 속한 검색 작업 목록을 반환합니다.
Request Syntax
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
URI 요청 파라미터
요청은 다음 URI 파라미터를 사용합니다.
- ByStatus
-
검색 작업 상태를 기준으로 목록을 필터링하려면 이 파라미터를 포함합니다.
유효 값:
RUNNING | COMPLETED | STOPPING | STOPPED | FAILED - MaxResults
-
반환할 리소스 목록 항목의 최대 수입니다.
유효한 범위: 최소값은 1입니다. 최대값은 1000입니다.
- NextToken
-
반환된 검색 작업의 일부 목록 다음에 나오는 다음 항목입니다.
예를 들어, 백업의
MaxResults수를 반환하기 위한 요청을 한 경우,NextToken을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.
Request Body
해당 요청에는 본문이 없습니다.
Response Syntax
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"
}
]
}응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- NextToken
-
검색 작업에 포함된 반환된 백업의 부분 목록을 따르는 다음 항목입니다.
예를 들어, 백업의
MaxResults수를 반환하기 위한 요청을 한 경우,NextToken을 사용하면 다음 토큰이 가리키는 위치에서 시작하여 목록에 있는 추가 항목을 반환할 수 있습니다.유형: 문자열
- SearchJobs
-
반환된 검색 작업의 세부 정보가 포함된 목록의 검색 작업입니다.
타입: SearchJobSummary 객체 배열
오류
모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하세요.
- AccessDeniedException
-
이 작업을 수행할 수 있는 충분한 액세스 권한이 없습니다.
- message
-
사용자에게 이 작업을 수행할 수 있는 충분한 액세스 권한이 없습니다.
HTTP 상태 코드: 403
- InternalServerException
-
내부 서버 오류가 발생했습니다. 요청을 재시도합니다.
- message
-
요청을 처리하는 동안 예상치 못한 오류가 발생했습니다.
- retryAfterSeconds
-
몇 초 후에 호출을 다시 시도합니다.
HTTP 상태 코드: 500
- ThrottlingException
-
요청 제한 때문에 요청이 거부되었습니다.
- message
-
요청 스로틀링으로 인해 요청이 실패했습니다.
- quotaCode
-
할당량이 있는 원래 서비스에 고유한 코드입니다.
- retryAfterSeconds
-
몇 초 후에 호출을 다시 시도합니다.
- serviceCode
-
원래 서비스에 고유한 코드입니다.
HTTP 상태 코드: 429
- ValidationException
-
입력이 서비스에서 지정한 제약 조건을 충족하지 못합니다.
- message
-
입력이 Amazon 서비스에서 지정한 제약 조건을 충족하지 못합니다.
HTTP 상태 코드: 400
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.
