调用DeployGateway接口可以部署一个按量付费的网关。
调用该接口时,您需要注意:
- 仅支持按量付费的云上文件网关。
- 仅支持部署状态为已初始化(Initialized)的云上文件网关。
- 部署完成后,您可以调用DescribeGateway接口查询网关状态,当状态为运行中(Running)时表示网关部署完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeployGateway |
系统规定参数。取值:DeployGateway。 |
GatewayClass | String | 是 | Basic |
网关规格。取值范围:
|
GatewayId | String | 是 | gw-0001xv7je3580031y*** |
网关ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
状态码。状态码为200表示请求成功。 |
Message | String | successful |
请求结果描述。 |
RequestId | String | 8FEAFE9D-66C2-46AB-833B-35269EC7524C |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
TaskId | String | t-0001xv7je35800307*** |
任务ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DeployGateway
&GatewayClass=Basic
&GatewayId=gw-0001xv7je3580031y***
&<公共请求参数>
正常返回示例
XML
格式
<DeployGatewayResponse>
<TaskId>t-0001xv7je35800307***</TaskId>
<Message>successful</Message>
<RequestId>8FEAFE9D-66C2-46AB-833B-35269EC7524C</RequestId>
<Code>200</Code>
<Success>true</Success>
</DeployGatewayResponse>
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. | 无效的网关规格。 |
访问错误中心查看更多错误码。