

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

# AWS Backup gateway
<a name="API_Operations_AWS_Backup_Gateway"></a>

AWS Backup gateway 支持以下操作：
+  [AssociateGatewayToServer](API_BGW_AssociateGatewayToServer.md) 
+  [CreateGateway](API_BGW_CreateGateway.md) 
+  [DeleteGateway](API_BGW_DeleteGateway.md) 
+  [DeleteHypervisor](API_BGW_DeleteHypervisor.md) 
+  [DisassociateGatewayFromServer](API_BGW_DisassociateGatewayFromServer.md) 
+  [GetBandwidthRateLimitSchedule](API_BGW_GetBandwidthRateLimitSchedule.md) 
+  [GetGateway](API_BGW_GetGateway.md) 
+  [GetHypervisor](API_BGW_GetHypervisor.md) 
+  [GetHypervisorPropertyMappings](API_BGW_GetHypervisorPropertyMappings.md) 
+  [GetVirtualMachine](API_BGW_GetVirtualMachine.md) 
+  [ImportHypervisorConfiguration](API_BGW_ImportHypervisorConfiguration.md) 
+  [ListGateways](API_BGW_ListGateways.md) 
+  [ListHypervisors](API_BGW_ListHypervisors.md) 
+  [ListTagsForResource](API_BGW_ListTagsForResource.md) 
+  [ListVirtualMachines](API_BGW_ListVirtualMachines.md) 
+  [PutBandwidthRateLimitSchedule](API_BGW_PutBandwidthRateLimitSchedule.md) 
+  [PutHypervisorPropertyMappings](API_BGW_PutHypervisorPropertyMappings.md) 
+  [PutMaintenanceStartTime](API_BGW_PutMaintenanceStartTime.md) 
+  [StartVirtualMachinesMetadataSync](API_BGW_StartVirtualMachinesMetadataSync.md) 
+  [TagResource](API_BGW_TagResource.md) 
+  [TestHypervisorConfiguration](API_BGW_TestHypervisorConfiguration.md) 
+  [UntagResource](API_BGW_UntagResource.md) 
+  [UpdateGatewayInformation](API_BGW_UpdateGatewayInformation.md) 
+  [UpdateGatewaySoftwareNow](API_BGW_UpdateGatewaySoftwareNow.md) 
+  [UpdateHypervisor](API_BGW_UpdateHypervisor.md) 

# AssociateGatewayToServer
<a name="API_BGW_AssociateGatewayToServer"></a>

将备份网关与您的服务器关联。完成关联过程后，您可以 VMs 通过网关进行备份和恢复。

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

```
{
   "GatewayArn": "string",
   "ServerArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用`ListGateways`操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [ServerArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-ServerArn"></a>
托管虚拟机的服务器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-response-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# CreateGateway
<a name="API_BGW_CreateGateway"></a>

创建备份网关。创建网关后，您可以通过 `AssociateGatewayToServer` 操作将其与服务器关联。

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

```
{
   "ActivationKey": "string",
   "GatewayDisplayName": "string",
   "GatewayType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [ActivationKey](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-ActivationKey"></a>
已创建网关的激活密钥。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 50。  
模式：`[0-9a-zA-Z\-]+`  
是否必需：是

 ** [GatewayDisplayName](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayDisplayName"></a>
已创建网关的显示名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
是否必需：是

 ** [GatewayType](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayType"></a>
已创建网关的类型。  
类型：字符串  
有效值：`BACKUP_VM`  
是否必需：是

 ** [Tags](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-Tags"></a>
分配给网关的最多 50 个标签的列表。每个标签都是一个键-值对。  
类型：[Tag](API_BGW_Tag.md) 对象数组  
必需：否

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **   <a name="Backup-BGW_CreateGateway-response-GatewayArn"></a>
您创建的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# DeleteGateway
<a name="API_BGW_DeleteGateway"></a>

删除备份网关。

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

```
{
   "GatewayArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_DeleteGateway_RequestSyntax) **   <a name="Backup-BGW_DeleteGateway-request-GatewayArn"></a>
要删除的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **   <a name="Backup-BGW_DeleteGateway-response-GatewayArn"></a>
您已删除的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# DeleteHypervisor
<a name="API_BGW_DeleteHypervisor"></a>

删除管理程序。

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

```
{
   "HypervisorArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_RequestSyntax) **   <a name="Backup-BGW_DeleteHypervisor-request-HypervisorArn"></a>
要删除的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **   <a name="Backup-BGW_DeleteHypervisor-response-HypervisorArn"></a>
您已删除的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# DisassociateGatewayFromServer
<a name="API_BGW_DisassociateGatewayFromServer"></a>

解除备份网关与指定服务器的关联。解除关联过程完成后，网关将无法再访问服务器上的虚拟机。

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

```
{
   "GatewayArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_RequestSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-request-GatewayArn"></a>
要解除关联的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-response-GatewayArn"></a>
您已解除关联的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# GetBandwidthRateLimitSchedule
<a name="API_BGW_GetBandwidthRateLimitSchedule"></a>

检索指定网关的带宽速率限制计划。默认情况下，网关没有带宽速率限制计划，这意味着没有有效的带宽速率限制。使用该参数可获取网关的带宽速率限制计划。

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

```
{
   "GatewayArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

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

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

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

 ** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-BandwidthRateLimitIntervals"></a>
包含网关带宽速率限制计划间隔的数组。如果没有安排带宽速率限制间隔，则该数组为空。  
类型：[BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 对象数组  
数组成员：最少 0 个物品。最多 20 个项目。

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# GetGateway
<a name="API_BGW_GetGateway"></a>

通过提供 ARN（Amazon 资源名称），此 API 将返回网关。

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

```
{
   "GatewayArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_GetGateway_RequestSyntax) **   <a name="Backup-BGW_GetGateway-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "Gateway": { 
      "DeprecationDate": number,
      "GatewayArn": "string",
      "GatewayDisplayName": "string",
      "GatewayType": "string",
      "HypervisorId": "string",
      "LastSeenTime": number,
      "MaintenanceStartTime": { 
         "DayOfMonth": number,
         "DayOfWeek": number,
         "HourOfDay": number,
         "MinuteOfHour": number
      },
      "NextUpdateAvailabilityTime": number,
      "SoftwareVersion": "string",
      "VpcEndpoint": "string"
   }
}
```

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

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

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

 ** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **   <a name="Backup-BGW_GetGateway-response-Gateway"></a>
通过提供 ARN（Amazon 资源名称），此 API 将返回网关。  
类型：[GatewayDetails](API_BGW_GatewayDetails.md) 对象

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# GetHypervisor
<a name="API_BGW_GetHypervisor"></a>

此操作请求有关网关将要连接到的指定管理程序的信息。管理程序是用于创建和管理虚拟机并为其分配资源的硬件、软件或固件。

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

```
{
   "HypervisorArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [HypervisorArn](#API_BGW_GetHypervisor_RequestSyntax) **   <a name="Backup-BGW_GetHypervisor-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "Hypervisor": { 
      "Host": "string",
      "HypervisorArn": "string",
      "KmsKeyArn": "string",
      "LastSuccessfulMetadataSyncTime": number,
      "LatestMetadataSyncStatus": "string",
      "LatestMetadataSyncStatusMessage": "string",
      "LogGroupArn": "string",
      "Name": "string",
      "State": "string"
   }
}
```

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

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

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

 ** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisor-response-Hypervisor"></a>
有关请求的管理程序的详细信息。  
类型：[HypervisorDetails](API_BGW_HypervisorDetails.md) 对象

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# GetHypervisorPropertyMappings
<a name="API_BGW_GetHypervisorPropertyMappings"></a>

此操作检索指定管理程序的属性映射。虚拟机管理程序属性映射显示虚拟机管理程序中可用的实体属性与中可用属性的关系。 AWS

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

```
{
   "HypervisorArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

 ** [IamRoleArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-IamRoleArn"></a>
IAM 角色的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`

 ** [VmwareToAwsTagMappings](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-VmwareToAwsTagMappings"></a>
这是标签与 VMware 标签的映射的显示。 AWS   
类型：[VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 对象数组

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# GetVirtualMachine
<a name="API_BGW_GetVirtualMachine"></a>

通过提供 ARN（Amazon 资源名称），此 API 将返回虚拟机。

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

```
{
   "ResourceArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [ResourceArn](#API_BGW_GetVirtualMachine_RequestSyntax) **   <a name="Backup-BGW_GetVirtualMachine-request-ResourceArn"></a>
虚拟机的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "VirtualMachine": { 
      "HostName": "string",
      "HypervisorId": "string",
      "LastBackupDate": number,
      "Name": "string",
      "Path": "string",
      "ResourceArn": "string",
      "VmwareTags": [ 
         { 
            "VmwareCategory": "string",
            "VmwareTagDescription": "string",
            "VmwareTagName": "string"
         }
      ]
   }
}
```

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

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

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

 ** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **   <a name="Backup-BGW_GetVirtualMachine-response-VirtualMachine"></a>
此对象包含 `GetVirtualMachine` 的输出所含的 `VirtualMachine` 的基本属性   
类型：[VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) 对象

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# ImportHypervisorConfiguration
<a name="API_BGW_ImportHypervisorConfiguration"></a>

通过导入管理程序的配置来连接管理程序。

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

```
{
   "Host": "string",
   "KmsKeyArn": "string",
   "Name": "string",
   "Password": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Username": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [Host](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Host"></a>
管理程序的服务器主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
是否必需：是

 ** [KmsKeyArn](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-KmsKeyArn"></a>
 AWS Key Management Service 适用于虚拟机管理程序。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`  
必需：否

 ** [Name](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Name"></a>
管理程序的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
是否必需：是

 ** [Password](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Password"></a>
管理程序的密码。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -~]+`  
必需：否

 ** [Tags](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Tags"></a>
要导入的管理程序配置的标签。  
类型：[Tag](API_BGW_Tag.md) 对象数组  
必需：否

 ** [Username](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Username"></a>
管理程序的用户名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`  
必需：否

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

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-response-HypervisorArn"></a>
您已解除关联的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# ListGateways
<a name="API_BGW_ListGateways"></a>

列出中由拥有 AWS 账户 的备份网关 AWS 区域。返回的列表是按网关 Amazon 资源名称 (ARN) 排序的。

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

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [MaxResults](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-MaxResults"></a>
要列出的网关的最大数量。  
类型：整数  
有效范围：最小值为 1。  
必需：否

 ** [NextToken](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `MaxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`  
必需：否

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

```
{
   "Gateways": [ 
      { 
         "GatewayArn": "string",
         "GatewayDisplayName": "string",
         "GatewayType": "string",
         "HypervisorId": "string",
         "LastSeenTime": number
      }
   ],
   "NextToken": "string"
}
```

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

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

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

 ** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-Gateways"></a>
您的网关列表。  
类型：[Gateway](API_BGW_Gateway.md) 对象数组

 ** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# ListHypervisors
<a name="API_BGW_ListHypervisors"></a>

列出您的管理程序。

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

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [MaxResults](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-MaxResults"></a>
要列出的管理程序的最大数量。  
类型：整数  
有效范围：最小值为 1。  
必需：否

 ** [NextToken](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`  
必需：否

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

```
{
   "Hypervisors": [ 
      { 
         "Host": "string",
         "HypervisorArn": "string",
         "KmsKeyArn": "string",
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

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

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

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

 ** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-Hypervisors"></a>
您的`Hypervisor`对象列表，按其 Amazon 资源名称排序 (ARNs)。  
类型：[Hypervisor](API_BGW_Hypervisor.md) 对象数组

 ** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# ListTagsForResource
<a name="API_BGW_ListTagsForResource"></a>

列出应用于由其 Amazon 资源名称 (ARN) 标识的资源的标记。

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

```
{
   "ResourceArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [ResourceArn](#API_BGW_ListTagsForResource_RequestSyntax) **   <a name="Backup-BGW_ListTagsForResource-request-ResourceArn"></a>
要列出的资源标记的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

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

 ** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-ResourceArn"></a>
您已列出的资源标记的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

 ** [Tags](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-Tags"></a>
资源标记列表。  
类型：[Tag](API_BGW_Tag.md) 对象数组

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# ListVirtualMachines
<a name="API_BGW_ListVirtualMachines"></a>

列出您的虚拟机。

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

```
{
   "HypervisorArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [HypervisorArn](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-HypervisorArn"></a>
连接到虚拟机的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：否

 ** [MaxResults](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-MaxResults"></a>
要列出的最大虚拟机数量。  
类型：整数  
有效范围：最小值为 1。  
必需：否

 ** [NextToken](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`  
必需：否

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

```
{
   "NextToken": "string",
   "VirtualMachines": [ 
      { 
         "HostName": "string",
         "HypervisorId": "string",
         "LastBackupDate": number,
         "Name": "string",
         "Path": "string",
         "ResourceArn": "string"
      }
   ]
}
```

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

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

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

 ** [NextToken](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-NextToken"></a>
所返回资源的部分列表的后续下一个项目。例如，如果请求返回 `maxResults` 数量的资源，则 `NextToken` 允许您从下一个令牌指向的位置开始返回列表中的更多项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1000。  
模式：`.+`

 ** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-VirtualMachines"></a>
您的`VirtualMachine`对象列表，按其 Amazon 资源名称排序 (ARNs)。  
类型：[VirtualMachine](API_BGW_VirtualMachine.md) 对象数组

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# PutBandwidthRateLimitSchedule
<a name="API_BGW_PutBandwidthRateLimitSchedule"></a>

此操作为指定网关设置带宽速率限制计划。默认情况下，网关没有带宽速率限制计划，这意味着没有有效的带宽速率限制。使用此操作可启动网关的带宽速率限制计划。

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

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [BandwidthRateLimitIntervals](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-BandwidthRateLimitIntervals"></a>
包含网关带宽速率限制计划间隔的数组。如果没有安排带宽速率限制间隔，则该数组为空。  
类型：[BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 对象数组  
数组成员：最少 0 个物品。最多 20 个项目。  
是否必需：是

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-response-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)。使用[https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)操作返回您的账户的网关列表和 AWS 区域。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# PutHypervisorPropertyMappings
<a name="API_BGW_PutHypervisorPropertyMappings"></a>

此操作设置指定管理程序的属性映射。虚拟机管理程序属性映射显示虚拟机管理程序中可用的实体属性与中可用属性的关系。 AWS

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

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [IamRoleArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-IamRoleArn"></a>
IAM 角色的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`  
是否必需：是

 ** [VmwareToAwsTagMappings](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-VmwareToAwsTagMappings"></a>
此操作请求标签与 VMware AWS 标签的映射。  
类型：[VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 对象数组  
是否必需：是

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

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-response-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# PutMaintenanceStartTime
<a name="API_BGW_PutMaintenanceStartTime"></a>

设置网关的维护开始时间。

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

```
{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayArn": "string",
   "HourOfDay": number,
   "MinuteOfHour": number
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [DayOfMonth](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfMonth"></a>
当月的某一天开始对网关进行维护。  
有效值范围为 `Sunday` 至 `Saturday`。  
类型：整数  
有效范围：最小值为 1。最大值为 31。  
必需：否

 ** [DayOfWeek](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfWeek"></a>
一周中的某一天开始对网关进行维护。  
类型：整数  
有效范围：最小值为 0。最大值为 6。  
必需：否

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-GatewayArn"></a>
网关的 Amazon 资源名称 (ARN)，用于指定其维护开始时间。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [HourOfDay](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-HourOfDay"></a>
一天中的某个时间开始维护网关。  
类型：整数  
有效范围：最小值为 0。最大值为 23。  
是否必需：是

 ** [MinuteOfHour](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-MinuteOfHour"></a>
一小时中的某个分钟点开始对网关进行维护。  
类型：整数  
有效范围：最小值为 0。最大值为 59。  
是否必需：是

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-response-GatewayArn"></a>
您设置维护开始时间的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# StartVirtualMachinesMetadataSync
<a name="API_BGW_StartVirtualMachinesMetadataSync"></a>

此操作会发送在指定虚拟机之间同步元数据的请求。

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

```
{
   "HypervisorArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-request-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-response-HypervisorArn"></a>
管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# TagResource
<a name="API_BGW_TagResource"></a>

标记资源。

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

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [ResourceARN](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-ResourceARN"></a>
要标记的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [Tags](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-Tags"></a>
分配给资源的标签列表。  
类型：[Tag](API_BGW_Tag.md) 对象数组  
是否必需：是

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

```
{
   "ResourceARN": "string"
}
```

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

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

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

 ** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **   <a name="Backup-BGW_TagResource-response-ResourceARN"></a>
您已标记的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# TestHypervisorConfiguration
<a name="API_BGW_TestHypervisorConfiguration"></a>

测试您的管理程序配置，以验证备份网关是否可以连接该管理程序及其资源。

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

```
{
   "GatewayArn": "string",
   "Host": "string",
   "Password": "string",
   "Username": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-GatewayArn"></a>
要测试的管理程序网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [Host](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Host"></a>
管理程序的服务器主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
是否必需：是

 ** [Password](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Password"></a>
管理程序的密码。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -~]+`  
必需：否

 ** [Username](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Username"></a>
管理程序的用户名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`  
必需：否

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

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

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

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

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# UntagResource
<a name="API_BGW_UntagResource"></a>

删除资源标签。

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

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [ResourceARN](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-ResourceARN"></a>
要删除其标签的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [TagKeys](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-TagKeys"></a>
指定要删除标签的标签键列表。  
类型：字符串数组  
长度限制：最小长度为 1。最大长度为 128。  
模式：`([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`  
必需：是

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

```
{
   "ResourceARN": "string"
}
```

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

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

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

 ** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **   <a name="Backup-BGW_UntagResource-response-ResourceARN"></a>
您已删除标签的资源的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# UpdateGatewayInformation
<a name="API_BGW_UpdateGatewayInformation"></a>

更新网关的名称。指定要在请求中使用网关的 Amazon 资源名称 (ARN) 更新哪个网关。

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

```
{
   "GatewayArn": "string",
   "GatewayDisplayName": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayArn"></a>
要更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [GatewayDisplayName](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayDisplayName"></a>
更新后的网关显示名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-response-GatewayArn"></a>
您已更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# UpdateGatewaySoftwareNow
<a name="API_BGW_UpdateGatewaySoftwareNow"></a>

更新网关虚拟机 (VM) 软件。该请求会立即触发软件更新。

**注意**  
您在发出此请求时会立即收到 `200 OK` 成功响应。但是，可能需要一段时间才能完成更新。

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

```
{
   "GatewayArn": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-request-GatewayArn"></a>
要更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
必需：是

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

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-response-GatewayArn"></a>
您已更新的网关的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 180。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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

# UpdateHypervisor
<a name="API_BGW_UpdateHypervisor"></a>

更新管理程序元数据，包括其主机、用户名和密码。指定要在请求中使用管理程序的 Amazon 资源名称 (ARN) 来更新哪个管理程序。

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

```
{
   "Host": "string",
   "HypervisorArn": "string",
   "LogGroupArn": "string",
   "Name": "string",
   "Password": "string",
   "Username": "string"
}
```

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

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

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

 ** [Host](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Host"></a>
更新后的管理程序的主机。这可以是 IP 地址或完全限定域名 (FQDN)。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 128。  
模式：`.+`  
必需：否

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-HypervisorArn"></a>
要更新的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`  
是否必需：是

 ** [LogGroupArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-LogGroupArn"></a>
请求日志中网关组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 2048。  
模式：`$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`  
必需：否

 ** [Name](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Name"></a>
更新后的管理程序名称  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z0-9-]*`  
必需：否

 ** [Password](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Password"></a>
更新后的管理程序密码。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -~]+`  
必需：否

 ** [Username](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Username"></a>
更新后的管理程序用户名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`  
必需：否

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

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **   <a name="Backup-BGW_UpdateHypervisor-response-HypervisorArn"></a>
您已更新的管理程序的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 50。最大长度为 500。  
模式：`arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`

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

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

 ** AccessDeniedException **   
由于您的权限不足，操作无法继续。    
 ** ErrorCode **   
对您的权限不足的原因的描述。
HTTP 状态代码：400

 ** ConflictException **   
由于不支持该操作，因此无法继续操作。    
 ** ErrorCode **   
对不支持该操作的原因的描述。
HTTP 状态代码：400

 ** InternalServerException **   
由于出现内部错误，因此操作未成功。请稍后重试。    
 ** ErrorCode **   
对发生的内部错误的描述。
HTTP 状态代码：500

 ** ResourceNotFoundException **   
未找到该操作所需的资源。    
 ** ErrorCode **   
对未找到的资源的描述。
HTTP 状态代码：400

 ** ThrottlingException **   
TPS 已被限制为防止故意或无意的高请求量。    
 ** ErrorCode **   
错误：TPS 已被限制为防止故意或无意的高请求量。
HTTP 状态代码：400

 ** ValidationException **   
由于出现验证错误，因此操作未成功。    
 ** ErrorCode **   
对导致验证错误的问题的描述。
HTTP 状态代码：400

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

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