You need to enable JavaScript to run this app.
导航
私网连接
  • 文档首页
    • /私网连接/API参考/网关终端节点/CreateVpcGatewayEndpoint
CreateVpcGatewayEndpoint
最近更新时间：2024.09.06 08:12:14首次发布时间：2023.07.07 09:56:29
我的收藏

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签之间使用&分隔。每个标签键对应一个标签值。

名称类型是否必选
示例值
描述
ActionString是CreateVpcGatewayEndpoint要执行的操作，取值为CreateVpcGatewayEndpoint。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
VpcIdString是vpc-bp15zkdt37pq72zv****网关终端节点所属VPC的ID。您可以调用DescribeVpcs接口获取VPC ID。
ServiceIdString是gwepsvc-2fe630gurkl37k5gfuy33****待关联网关终端节点服务的ID。您可以调用DescribeVpcGatewayEndpointServices接口获取网关终端节点服务的ID。

EndpointName

String

否

endpoint-01

网关终端节点的名称。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和中划线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不填默认为网关终端节点的ID。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

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

  • 该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 取值仅支持ASCII字符，最大不超过64个字符。
  • 未指定该参数值时，不进行幂等校验。

Description

String

否

GatewayEndpoint

网关终端节点的描述，默认值为空字符串。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ～ 255个字符。
ProjectNameString否default网关终端节点所属项目的名称。

VpcPolicy

String

否

{
  "Statement" : [
    {
      "Effect": "Allow",
      "Principal": "*",
      "Action": "*",
      "Resource": "*",
    }
  ]
}

网关终端节点的访问策略。不填默认为默认策略。默认策略表示允许网关终端节点访问对象存储服务的所有桶资源。
访问策略中各字段的详细说明请参见存储桶策略参数说明。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

终端节点用户标签的标签键。

  • 长度限制为1～128个字符。
  • 大小写敏感，不能以volc:或sys:的任意大小写组合开头。
  • 不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

同一资源的标签键不允许重复。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

终端节点用户标签的标签值。

  • 长度限制为0～255个字符。
  • 大小写敏感，不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

如果传入该参数，则必须先传入Tags.N.Key。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
EndpointIdStringgwep-273yuq6q7bgn47fap8squ****网关终端节点的ID。

请求示例

GET /?Action=CreateVpcGatewayEndpoint&Version=2020-04-01&VpcId=vpc-bp15zkdt37pq72zv****&ServiceId=gwepsvc-2fe630gurkl37k5gfuy33****&VpcPolicy= { "Statement": [ { "Effect": "Deny", "Principal": ["trn:iam::1213414321:user/aaa_"], "Action": "*", "Resource": "*" } ] } HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "CreateVpcGatewayEndpoint",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "EndpointId": "gwep-273yuq6q7bgn47fap8squ****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400IdempotentParameterMismatchThe request uses the same ClientToken as a previous, but non-identical request. Do not reuse a ClientToken with different requests, unless the requests are identical.该请求使用了与另外请求相同的 ClientToken，请不要在不同请求中复用相同的 ClientToken。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的 ClientToken 参数格式不合法。
400InvalidDescription.MalformedThe specified Description is malformed.指定的 Description 参数格式不合法。
400InvalidName.MalformedThe specified Name is malformed.指定的 Name 参数格式不合法。
400InvalidPolicy.Action.MalformedThe specified Policy.Action is malformed.指定的 Policy.Action 参数格式不合法。
400InvalidPolicy.Effect.MalformedThe specified Policy.Effect is malformed.指定的 Policy.Effect 参数格式不合法。
400InvalidPolicy.Principal.MalformedThe specified Policy.Principal is malformed.指定的 Policy.Principal 参数格式不合法。
400InvalidPolicy.Resource.MalformedThe specified Policy.Resource is malformed.指定的 Policy.Resource 参数格式不合法。
400InvalidPolicy.Statement.MalformedThe specified Policy.Statement is malformed.指定的 Policy.Statement 参数格式不合法。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。

说明

其中，XXX表示缺少的参数名称。

400InvalidProjectName.MalformedThe specified ProjectName is malformed.指定的 ProjectName 参数格式不合法。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified TagKey is malformed.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的 TagValue 参数格式不合法。
400LimitExceeded.TagOperationYou've reached the limit on the number of tags that you can operate at a time.已达到单次可操作的标签条目数量上限。
400InvalidVpcAccount.MismatchedThe specified VPC and account don't match.指定的私有网络和账户不匹配。
400InvalidPolicy.Condition.MalformedThe specified Policy.Condition is malformed.指定的 Policy.Condition 参数格式不合法。
400InvalidPolicy.ConditionKey.MalformedThe specified Policy.ConditionKey is malformed.指定的 Policy.ConditionKey 参数格式不合法。
400InvalidPolicy.ConditionOperator.MalformedThe specified Policy.ConditionOperator is malformed.指定的 Policy.ConditionOperator 参数格式不合法。
400InvalidPolicy.ConditionValue.MalformedThe specified Policy.ConditionValue is malformed.指定的 Policy.ConditionValue 参数格式不合法。
400InvalidEndpoint.ServiceMisMatchThe specified endpoint and service don't match.指定的终端节点和终端节点服务不匹配。
404InvalidVpc.NotFoundThe specified vpc does not exist.指定的私有网络不存在。
404InvalidGatewayEpsvc.NotFoundThe specified GatewayEndpointService does not exist.指定的网关终端节点服务不存在。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
409InvalidGatewayEp.ConflictThe GatewayEndpoint of the vpc has been created.已创建过该私有网络的网关终端节点。
412IdempotentProcessingThe request uses the same ClientToken as a previous one that is still in process.幂等请求处理中。