DeployGateway - 部署一个按量付费的网关_云存储网关(CSG)-阿里云帮助中心

接口说明

调用该接口时，您需要注意：

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DeployGateway

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-0001xv7je3580031y***
GatewayClass	string	否	网关规格。取值范围： Basic：基础型。 Standard：标准型。 Enhanced：增强型。 Advanced：性能型。	Basic

返回参数

名称	类型	描述	示例值
	object
TaskId	string	任务 ID。	t-0001xv7je35800307***
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	8FEAFE9D-66C2-46AB-833B-35269EC7524C
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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.	无效的网关规格。

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

变更历史

更多信息，参考变更详情。