本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# UpdateRecoveryPointIndexSettings
<a name="API_UpdateRecoveryPointIndexSettings"></a>

此操作用于更新恢复点索引的设置。

必填项： BackupVaultName RecoveryPointArn、和 IAMRole Arn

## 请求语法
<a name="API_UpdateRecoveryPointIndexSettings_RequestSyntax"></a>

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
Content-type: application/json

{
   "IamRoleArn": "string",
   "Index": "string"
}
```

## URI 请求参数
<a name="API_UpdateRecoveryPointIndexSettings_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [backupVaultName](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 区域中是唯一的。  
可以使用的字符包括小写字母、数字和连字符。  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`  
是否必需：是

 ** [recoveryPointArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-RecoveryPointArn"></a>
唯一标识恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
是否必需：是

## 请求体
<a name="API_UpdateRecoveryPointIndexSettings_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [IamRoleArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-IamRoleArn"></a>
此值用于指定此操作所使用的 IAM 角色 ARN。  
示例：arn:aws:iam::123456789012:role/S3Access  
类型：字符串  
必需：否

 ** [Index](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-Index"></a>
索引可能取两个值中的一个，可以是 `ENABLED` 或 `DISABLED`。  
要为尚无备份索引的符合条件的 `ACTIVE` 恢复点创建备份索引，请将值设置为 `ENABLED`。  
要删除备份索引，请将值设置为 `DISABLED`。  
类型：字符串  
有效值：`ENABLED | DISABLED`  
是否必需：是

## 响应语法
<a name="API_UpdateRecoveryPointIndexSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultName": "string",
   "Index": "string",
   "IndexStatus": "string",
   "RecoveryPointArn": "string"
}
```

## 响应元素
<a name="API_UpdateRecoveryPointIndexSettings_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [BackupVaultName](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-BackupVaultName"></a>
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 区域中是唯一的。  
类型：字符串  
模式：`^[a-zA-Z0-9\-\_]{2,50}$`

 ** [Index](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-Index"></a>
索引可能取两个值中的一个，可以是 `ENABLED` 或 `DISABLED`。  
值为 `ENABLED` 表示已为符合条件的 `ACTIVE` 恢复点创建了备份索引。  
值为 `DISABLED` 表示备份索引已被删除。  
类型：字符串  
有效值：`ENABLED | DISABLED`

 ** [IndexStatus](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-IndexStatus"></a>
这是与指定恢复点关联的备份索引的当前状态。  
状态为：`PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
具有状态为 `ACTIVE` 的索引的恢复点可包含在搜索中。  
类型：字符串  
有效值：`PENDING | ACTIVE | FAILED | DELETING`

 ** [RecoveryPointArn](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-RecoveryPointArn"></a>
唯一标识恢复点的 ARN；例如，`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`。  
类型：字符串

## 错误
<a name="API_UpdateRecoveryPointIndexSettings_Errors"></a>

有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示参数的值有问题。例如，该值超出了范围。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** InvalidRequestException **   
表示请求的输入有问题。例如，参数的类型错误。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** MissingParameterValueException **   
表示缺少必需的参数。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作所需的资源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：400

 ** ServiceUnavailableException **   
由于服务器发生临时故障而导致请求失败。    
 ** Context **   
  
 ** Type **   

HTTP 状态代码：500

## 另请参阅
<a name="API_UpdateRecoveryPointIndexSettings_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings)