本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
StartSearchJob
此操作将创建一个搜索作业,该作业返回由 SearchScope 筛选的恢复点和由 ItemFilters 筛选的项目。
您可以选择添加 ClientToken、EncryptionKeyArn、Name 和/或 Tags。
请求语法
PUT /search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"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",
"SearchScope": {
"BackupResourceArns": [ "string" ],
"BackupResourceCreationTime": {
"CreatedAfter": number,
"CreatedBefore": number
},
"BackupResourceTags": {
"string" : "string"
},
"BackupResourceTypes": [ "string" ],
"SourceResourceArns": [ "string" ]
},
"Tags": {
"string" : "string"
}
}
URI 请求参数
该请求不使用任何 URI 参数。
请求正文
请求接受采用 JSON 格式的以下数据。
- ClientToken
-
包含此参数可允许进行多次相同调用,以实现幂等性。
客户端令牌自首次使用该令牌的请求完成后 8 小时内有效。8 小时后,所有具有相同令牌的请求都将视为新请求。
类型:字符串
必需:否
- EncryptionKeyArn
-
指定搜索作业的加密密钥。
类型:字符串
必需:否
- ItemFilters
-
项目筛选条件表示创建搜索时指定的所有输入项目属性。
包含 EBSItemFilters 或 S3ItemFilters
类型:ItemFilters 对象
必需:否
- Name
-
需包含字母数字字符,为该搜索作业创建一个名称。
类型:字符串
长度约束:最小长度为 0。最大长度为 500。
必需:否
- SearchScope
-
此对象可以包含 BackupResourceTypes、BackupResourceArns、BackupResourceCreationTime、BackupResourceTags 和 SourceResourceArns,用于筛选搜索作业返回的恢复点。
类型:SearchScope 对象
必需:是
- Tags
-
操作返回的标签列表。
类型:字符串到字符串映射
必需:否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"SearchJobArn": "string",
"SearchJobIdentifier": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- CreationTime
-
作业的创建日期和时间,采用 Unix 时间格式和协调世界时(UTC)。
CompletionTime的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型:时间戳
- SearchJobArn
-
标识指定搜索作业的 Amazon 资源名称(ARN)的唯一字符串。
类型:字符串
- SearchJobIdentifier
-
指定搜索作业的唯一字符串。
类型:字符串
错误
有关所有操作的常见错误信息,请参阅 常见错误。
- AccessDeniedException
-
您没有足够的访问权限,无法执行该操作。
- message
-
用户没有足够的访问权限,无法执行该操作。
HTTP 状态代码:403
- ConflictException
-
当检测到与之前成功执行的操作存在冲突时,会触发此异常。当上一项操作没有时间传播到处理当前请求的主机时,通常会发生这种情况。
对于此异常,建议的应对方式是重试(需配合适当的退避逻辑)。
- message
-
更新或删除资源可能会导致状态不一致。
- resourceId
-
受影响资源的标识符。
- resourceType
-
受影响资源的类型。
HTTP 状态代码:409
- InternalServerException
-
发生内部服务器错误。重试您的请求。
- message
-
请求处理过程中发生意外错误。
- retryAfterSeconds
-
等待指定秒数后重试此调用。
HTTP 状态代码:500
- ResourceNotFoundException
-
未找到此请求所需的资源。
确认资源信息(例如 ARN 或类型)正确无误且存在,然后重试请求。
- message
-
请求引用的资源不存在。
- resourceId
-
受影响资源的假设性标识符。
- resourceType
-
受影响资源的假设性类型。
HTTP 状态代码:404
- ServiceQuotaExceededException
-
由于超出允许的配额限制,请求被拒绝。
- message
-
由于服务配额超过限制,此请求失败。
- quotaCode
-
这是配额类型特有的代码。
- resourceId
-
资源的标识符。
- resourceType
-
资源的类型。
- serviceCode
-
这是具有限额的原始服务所独有的代码。
HTTP 状态代码:402
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
- message
-
由于请求节流,请求失败。
- quotaCode
-
这是具有限额的原始服务所独有的代码。
- retryAfterSeconds
-
等待指定秒数后重试此调用。
- serviceCode
-
这是原始服务所独有的代码。
HTTP 状态代码:429
- ValidationException
-
输入未能满足服务指定的约束条件。
- message
-
输入未能满足 Amazon 服务指定的约束条件。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: