CreateGateway_云存储网关_API文档

2018-05-11

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

请确保在使用该接口前，已充分了解云存储网关产品的收费方式和价格。
您已经注册阿里云账号，并完成实名认证。
您已经开通云存储网关服务。
您在需要创建云上网关的地域，已有可用的专有网络 VPC 和虚拟交换机 vSwitch。
您在需要创建云上网关的地域，已有可用的云服务器 ECS，并将此服务器归属到已创建的专有网络 VPC 下。
在创建网关前，确保您已创建网关集群，如果还未创建，可以通过 CreateStorageBundle 接口完成网关集群的创建。
如果您的网关付费类型为包年包月，完成网关创建后，您需要通过接口返回的购买链接进行网关购买，完成网关的创建。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

hcs-sgw:CreateGateway	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
StorageBundleIdstring	网关集群 ID，如果不指定 ResourceRegionId，则必须指定该参数。示例值:sb-0001b2otnkdxrigeq***参考取值来源: ModifyStorageBundle CreateStorageBundle DescribeStorageBundles
Namestring	网关名称。长度为 60 个字符且以大小写字母或者中文开头，可以包含大小写字母，中文、数字、下划线（_）、短划线（-）和半角句号（.）。示例值:alex***
Descriptionstring	网关描述。长度限制 0~255 个字符。示例值:测试使用
Categorystring	网关类别。默认值为`Aliyun`。示例值:Aliyun
Typestring	网关类型。取值范围：展开详情示例值:File
Locationstring	网关位置。取值范围：展开详情示例值:Cloud
GatewayClassstring	网关规格。该参数涉及费用，详情请参见计量项和计费项。展开详情示例值:Basic参考取值来源: DescribeGateways
VSwitchIdstring	虚拟交换机的 ID。如果您的网关位置在本地数据中心，可以忽略这个参数。展开详情示例值:vsw-bp1krhkglx3nahkb9s***
PostPaidboolean	网关付费类型。该参数涉及费用，详情请参见计量项和计费项。展开详情示例值:true
ReleaseAfterExpirationboolean	预付费情况下，是否到期释放。可能值如下：展开详情示例值:true
PublicNetworkBandwidthinteger<int32>	数据公网带宽。单位为 Mbps。取值范围为 5~200。该参数涉及费用，详情请参见计量项和计费项。展开详情示例值:5
ResourceRegionIdstring	资源地域 ID。示例值:cn-hangzhou
UntrustedEnvInstanceTypestring	非授信（云盒）场景下网关的实际规格。示例值:ecs.g6.large
UntrustedEnvIdstring	非授信（云盒）实例 ID。示例值:cb-2vcdsa32432***
SecondaryVSwitchIdstring	高可用网关备节点虚拟交换机 ID。示例值:vsw-bp1krhkglx3nahcx9s***

返回参数

字段名称	字段详情
BuyURLstring	购买链接。示例值:https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***","directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy
RequestIdstring	请求 ID。示例值:8E69E1A1-9076-4C8C-8ADF-ACD253886E22
Messagestring	请求结果描述。示例值:successful
GatewayIdstring	网关 ID。示例值:gw-0001xv7je357zm9u6***
Codestring	状态码。状态码为 200 表示请求成功。示例值:200
Successboolean	请求是否成功。示例值:true

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	EmptyGatewayName	You must enter a valid name for the gateway.	诊断
400	InvalidGatewayName	The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	诊断
400	DescriptionOverLimit	The length of the specified gateway description exceeds the maximum limit. The description cannot exceed 255 characters.	诊断
400	EmptyStorageBundleId	You must enter a valid ID for the gateway cluster.	诊断
400	InvalidGatewayClass	The specified specification of the gateway is invalid.	诊断
400	InvalidGatewayType	The specified type of the gateway is invalid.	诊断
400	InvalidVSwitchId	The specified VSwitch ID does not exist.	诊断
400	NoAvailableOnlineResource	There are no cloud gateways available. We recommend that you select a different specification or VSwitch that resides in another zone.	诊断
400	DuplicateGatewayName	The specified name of the gateway already exists. You must specify a valid name.	诊断
400	InvalidGatewayBandwidth	The specified public network bandwidth for the gateway is invalid. The bandwidth ranges from 6 to 200 Mbit/s.	诊断
400	GatewayBandwidthNotSupported	You cannot decrease the public network bandwidth of a On Premise Gateway.	诊断
400	InvalidGatewayLocation	The specified location of the gateway is invalid.	诊断
400	ServiceReleased	Service is released, please open service again.	诊断
404	StorageBundleNotExist	The name you specified for the gateway cluster does not exist. You must specify a valid parameter.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-07	新增请求参数Category
	2024-09-25	变更错误码400 变更请求参数StorageBundleId
	2024-03-14	新增请求参数UntrustedEnvInstanceType 新增请求参数UntrustedEnvId 新增请求参数SecondaryVSwitchId
	2022-06-09	新增请求参数ResourceRegionId

相关示例