ListSearchJobs
此操作会返回属于某个账户的搜索作业列表。
请求语法
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允许您从下一个令牌指向的位置开始返回列表中的更多项目。
请求体
该请求没有请求正文。
响应语法
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 的更多信息，请参阅以下内容：
