CreateIpv4Gateway_专有网络_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • CreateIpv4Gateway 接口属于异步接口,即系统返回一个实例 ID,但该 IPv4 网关尚未创建成功,系统后台的创建任务仍在进行。您可以调用 GetIpv4GatewayAttribute 查询 IPv4 网关的创建状态:
    • 当 IPv4 网关处于 Creating 状态时,表示 IPv4 网关正在创建中。
    • 当 IPv4 网关处于 Created 状态时,表示 IPv4 网关创建完成。
  • CreateIpv4Gateway 接口不支持在同一个 VPC 下并发创建 IPv4 网关。

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
vpc:CreateIpv4Gateway
Create
Ipv4Gateway
acs:vpc:{#regionId}:{#accountId}:ipv4gateway/*

请求参数

字段名称字段详情
Ipv4GatewayNamestring

创建的 IPv4 网关的名称。展开详情

示例值:ipv4参考取值来源:
    ListIpv4Gateways
    GetIpv4GatewayAttribute
Ipv4GatewayDescriptionstring

创建的 IPv4 网关的描述信息。展开详情

示例值:test
VpcIdstring

创建的 IPv4 网关所在 VPC 的 ID。展开详情

示例值:vpc-5tss06uvoyps5xoya****参考取值来源:
    CreateVpc
DryRunboolean

是否只预检此次请求。取值:展开详情

示例值:false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。展开详情

示例值:123e4567-e89b-12d3-a456-426655440000
RegionIdstring

创建 IPv4 网关的地域 ID。展开详情

示例值:ap-southeast-6参考取值来源:
    DescribeRegions
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmxazb4ph6aiy****
Tagarray<object>

资源的标签。

子级条数 <= 21

返回参数

字段名称字段详情
Ipv4GatewayIdstring

创建的 IPv4 网关的实例 ID。

示例值:ipv4gw-5tsnc6s4ogsedtp3k****
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmxazb4ph6aiy****
RequestIdstring

请求 ID。

示例值:F282742B-1BBB-5F63-A3AF-E92EC575A1A6

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
OperationDenied.ExistDirectEip
The operation is not allowed because of existing direct eip.诊断
400
UnsupportedRegion
The feature of ipv4Gateway is not supported in the region.诊断
400
Forbidden.OperateShareResource
You cannot operate shared resources.诊断
400
OperationDenied.SubnetRouteV1Exist
The operation is not allowed because of existing subnetRouteV1.诊断
400
OperationDenied.NormalNatExist
The operation is not allowed because of existing normalNat.诊断
400
OperationDenied.VpcExistIpv4Gateway
An IPv4 gateway already exists in the VPC.诊断
400
UnsupportedFeature.Ipv4Gateway
The feature of ipv4Gateway is not supported for [%s].诊断
400
OperationDenied.VpnExist
The operation is not allowed because of existing vpn.诊断
400
OperationDenied.DirectEipExist
The operation is not allowed because of existing directEip.诊断
400
OperationFailed.GetNfvServiceList
The operation is failed because of get nfv serviceList failed.诊断
400
IncorrectStatus.Vpc
The status of %s [%s] is incorrect.诊断
400
OperationFailed.VpcNotExist
The operation is failed because of vpc is not found.诊断
400
IllegalParam.ResourceGroupId
Invalid ResourceGroupld value.诊断

变更历史

变更时间变更内容概要操作
2023-07-18
变更错误码400
2023-07-05
新增请求参数Tag
删除返回参数
2021-11-02
新增OpenAPI,创建IPv4网关

相关示例

1.创建vpc->创建vswitch->创建ipv4网关->使能ipv4网关->修改ipv4网关名称、描述等属性 2.创建网关路由表->查询ipv4网关->绑定网关路由表到ipv4网关 3.创建ecs->网关路由表指定路由下一跳为ecs->查询网关路由条目 4.查询ipv4网关->解绑ipv4网关->删除ipv4网关
2021-12-17