CreateVpcGatewayEndpoint_专有网络_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.

接口说明

  • CreateVpcGatewayEndpoint 接口属于异步接口,即系统返回一个 EndpointId,但该网关终端节点尚未创建成功,系统后台的创建任务仍在进行。您可以调用 ListVpcGatewayEndpoints 查询网关终端节点的创建状态:
    • 当网关终端节点处于 Creating 状态时,表示网关终端节点正在创建中。
    • 当网关终端节点处于 Created 状态时,表示网关终端节点创建成功。
  • CreateVpcGatewayEndpoint 接口不支持针对同一个终端节点服务并发创建网关终端节点。

流控信息

请求速率为600/60(s)。

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
VpcIdstring

要创建网关终端节点的 VPC ID。展开详情

示例值:vpc-bp1gsk7h12ew7oegk****参考取值来源:
    CreateVpc
ServiceNamestring

终端节点服务名称。

示例值:com.aliyun.cn-hangzhou.oss
PolicyDocumentstring

云服务的访问策略。展开详情

示例值:{ "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }
EndpointNamestring

网关终端节点的名称。展开详情

示例值:test参考取值来源:
    ListVpcGatewayEndpoints
    GetVpcGatewayEndpointAttribute
EndpointDescriptionstring

网关终端节点的描述信息。展开详情

示例值:test
ClientTokenstring

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

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRunboolean

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

示例值:false
ResourceGroupIdstring

网关终端节点所属的资源组 ID。

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

资源的标签。

子级条数 <= 21
RegionIdstring

要创建的网关终端节点的地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:62CFC815-E08A-5CF4-92D1-54273EC9E406
EndpointIdstring

网关终端节点实例 ID。

示例值:vpce-bp1w1dmdqjpwul0v3****
ServiceNamestring

终端节点服务名称。

示例值:com.aliyun.cn-hangzhou.oss
EndpointNamestring

网关终端节点的名称。

示例值:test
CreationTimestring

网关终端节点的创建时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

示例值:2021-08-27T01:58:37Z
ResourceGroupIdstring

网关终端节点所属的资源组 ID。

示例值:rg-acfmxazb4ph****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
OperationFailed.ConcurrentOperation
The operation is failed because of concurrent operation.诊断
400
IdempotentParameterMismatch
The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.诊断
400
IllegalParam.PolicyDocument
The param of PolicyDocument is illegal.诊断
400
IllegalParam.GatewayEndpointName
The param of GatewayEndpointName is illegal.诊断
400
IllegalParam.GatewayEndpointDescription
The param of GatewayEndpointDescription is illegal.诊断
400
ResourceAlreadyExist.GatewayEndpoint
The specified resource gateway endpoint is already exist.诊断
400
ResourceNotFound.ServiceName
The specified resource service name is not found.诊断
400
ResourceNotFound.VpcId
The specified resource vpc is not found.诊断
400
Forbidden.OperateShareResource
The operation is failed because of shared vpc.诊断
400
IncorrectStatus.Vpc
The status of vpc [%s] is incorrect.诊断
400
IncorrectStatus.CenStatus
The status of vpc cenStatus [%s] is incorrect.诊断
400
OperationFailed.VpcIpv6Disabled
The operation is failed because of VpcIpv6Disabled.诊断
400
UnsupportedFeature.GatewayEndpoint
The feature of gatewayEndpoint is not supported for %s.诊断
400
SystemBusy
System is busy, please try again later.诊断
400
Forbbiden
User not authorized to operate on the specified resource.诊断
400
OperationDenied.PolicyDocument
The gatewayEndpoint does not support policy.诊断
400
MissingParam.PolicyDocument
The param of PolicyDocument is missing.诊断
400
OperationDenied.NotAuthorized
User not authorized to operate on the specified resource.诊断
400
InvalidPolicy.WrongFormat
Invalid input policy format.诊断

变更历史

变更时间变更内容概要操作
2023-07-05
新增请求参数Tag
删除返回参数
2023-05-29
变更错误码400
2023-03-23
新增请求参数ResourceGroupId
变更返回参数

相关示例

创建路由表 --> 创建网关终端节点 --> 修改终端节点的policy --> 绑定终端节点和两个路由表 --> 查询绑定关系为Associated
2021-12-17