DeployGateway

调用DeployGateway接口可以部署一个按量付费的网关。

调用该接口时,您需要注意:

  • 仅支持按量付费的云上文件网关。
  • 仅支持部署状态为已初始化(Initialized)的云上文件网关。
  • 部署完成后,您可以调用DescribeGateway接口查询网关状态,当状态为运行中(Running)时表示网关部署完成。

请求参数

名称

类型

是否必选

示例值

描述

Action String DeployGateway

系统规定参数。取值:DeployGateway

GatewayId String gw-0001xv7je3580031y***

网关ID。

GatewayClass String Basic

网关规格。取值范围:

  • Basic:基础型。
  • Standard:标准型。
  • Enhanced:增强型。
  • Advanced:性能型。

返回数据

名称

类型

示例值

描述

TaskId String t-0001xv7je35800307***

任务ID。

Message String successful

请求结果描述。

RequestId String 8FEAFE9D-66C2-46AB-833B-35269EC7524C

请求ID。

Code String 200

状态码。状态码为200表示请求成功。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=DeployGateway
&GatewayClass=Basic
&GatewayId=gw-0001xv7je3580031y***
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeployGatewayResponse>
    <TaskId>t-0001xv7je35800307***</TaskId>
    <Message>successful</Message>
    <RequestId>8FEAFE9D-66C2-46AB-833B-35269EC7524C</RequestId>
    <Code>200</Code>
    <Success>true</Success>
</DeployGatewayResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "t-0001xv7je35800307***",
  "Message" : "successful",
  "RequestId" : "8FEAFE9D-66C2-46AB-833B-35269EC7524C",
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode

错误码

错误信息

描述

400 EmptyGatewayId You must enter a valid ID for the gateway. 网关ID不能为空。
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在,请确认输入参数是否正确。
400 BadRequest Invalid request. You must specify valid parameters in the request.  非法请求,请检查请求参数。
400 InvalidGatewayLocation The specified location of the gateway is invalid. 无效的网关位置。
400 InvalidGatewayClass The specified specification of the gateway is invalid. 无效的网关规格。

访问错误中心查看更多错误码。