调用CreateVpcGatewayEndpoint接口创建网关终端节点。

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateVpcGatewayEndpoint

系统规定参数。取值：CreateVpcGatewayEndpoint。
VpcId String 是 vpc-bp1gsk7h12ew7oegk****

要创建网关终端节点的VPC ID。

该VPC必须与网关终端节点在同一个地域。
ServiceName String 是 com.aliyun.cn-hangzhou.oss

终端节点服务名称。
PolicyDocument String 否 { "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }

云服务的访问策略。

关于访问策略的语法和结构，请参见权限策略语法和结构。
EndpointName String 否 test

网关终端节点的名称。

名称的长度在1~128个字符之间。
EndpointDescription String 否 test

网关终端节点的描述信息。

描述信息的长度在1~255个字符之间。
ClientToken String 否 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
DryRun Boolean 否 false

是否只预检此次请求，取值：

  • true：发送检查请求，不会创建网关终端节点。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回2xx HTTP状态码并创建网关终端节点。
ResourceGroupId String 否 rg-acfmxazb4ph****

网关终端节点所属的资源组ID。
RegionId String 是 cn-hangzhou

要创建的网关终端节点的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 62CFC815-E08A-5CF4-92D1-54273EC9E406

请求ID。
EndpointId String vpce-bp1w1dmdqjpwul0v3****

网关终端节点实例ID。
ServiceName String com.aliyun.cn-hangzhou.oss

终端节点服务名称。
EndpointName String test

网关终端节点的名称。
CreationTime String 2021-08-27T01:58:37Z

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpcGatewayEndpoint
&VpcId=vpc-bp1gsk7h12ew7oegk****
&ServiceName=com.aliyun.cn-hangzhou.oss
&PolicyDocument={   "Version" : "1",   "Statement" : [ {     "Effect" : "Allow",     "Resource" : [ "*" ],     "Action" : [ "*" ],     "Principal" : [ "*" ]   } ] }
&EndpointName=test
&EndpointDescription=test
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&DryRun=false
&ResourceGroupId=rg-acfmxazb4ph****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVpcGatewayEndpointResponse>
    <RequestId>62CFC815-E08A-5CF4-92D1-54273EC9E406</RequestId>
    <EndpointId>vpce-bp1w1dmdqjpwul0v3****</EndpointId>
    <ServiceName>com.aliyun.cn-hangzhou.oss</ServiceName>
    <EndpointName>test</EndpointName>
    <CreationTime>2021-08-27T01:58:37Z</CreationTime>
    <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
</CreateVpcGatewayEndpointResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "62CFC815-E08A-5CF4-92D1-54273EC9E406",
  "EndpointId" : "vpce-bp1w1dmdqjpwul0v3****",
  "ServiceName" : "com.aliyun.cn-hangzhou.oss",
  "EndpointName" : "test",
  "CreationTime" : "2021-08-27T01:58:37Z",
  "ResourceGroupId" : "rg-acfmxazb4ph****"
}

错误码

HttpCode 错误码 错误信息 描述
400 Forbbiden User not authorized to operate on the specified resource. 您没有权限操作该资源，请您申请操作权限后再试。

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