You need to enable JavaScript to run this app.
文档中心
私网连接

私网连接

复制全文
下载 pdf
网关终端节点
CreateVpcGatewayEndpoint - 创建网关终端节点实例
复制全文
下载 pdf
CreateVpcGatewayEndpoint - 创建网关终端节点实例
调用CreateVpcGatewayEndpoint接口,创建一个网关终端节点。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:CreateVpcGatewayEndpoint​
要执行的操作,取值:CreateVpcGatewayEndpoint。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
VpcId String 必选 示例值:vpc-bp15zkdt37pq72zv****​
网关终端节点所属VPC的ID。​
您可以调用DescribeVpcs接口,获取VPC ID。​
​
ServiceId String 必选 示例值: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个字符。​
​
ProjectName String 可选 示例值:default​
网关终端节点所属项目的名称。​
​
VpcPolicy String 可选 示例值:{ "Statement" : [ { "Effect": "Allow", "Principal": "*", "Action": "*", "Resource": "*" } ] }​
网关终端节点的访问策略。不填默认为默认策略。默认策略表示允许网关终端节点访问对象存储服务的所有桶资源。​
访问策略中各字段的详细说明请参见存储桶策略参数说明。​
​
Tags.N.Key String 可选 示例值:k1​
终端节点用户标签的标签键。​
  • 长度限制为1~128个字符。​
  • 大小写敏感,不能以volc:或sys:的任意大小写组合开头。​
  • 不能以空格开头或结尾。​
  • 允许包含字母、数字、空格()、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。​
说明​
同一资源的标签键不允许重复。​
​
Tags.N.Value String 可选 示例值:v1​
终端节点用户标签的标签值。​
  • 长度限制为0~255个字符。​
  • 大小写敏感,不能以空格开头或结尾。​
  • 允许包含字母、数字、空格()、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。​
说明​
如果传入该参数,则必须先传入Tags.N.Key。​
​
​
​
返回参数​
RequestId String 示例值:0ED8D006-F706-4D23-88ED-E11ED28D****​
请求ID。​
​
EndpointId String 示例值:gwep-273yuq6q7bgn47fap8squ****​
网关终端节点的ID。​
​
​
​
请求示例​
​
GET /?Action=CreateVpcGatewayEndpoint&Version=2020-04-01&VpcId=vpc-bp15zkdt37pq72zv****&ServiceId=gwepsvc-2fe630gurkl37k5gfuy33****&EndpointName=endpoint-01&ClientToken=123e4567-e89b-12d3-a456-42665544****&Description=GatewayEndpoint&ProjectName=default&VpcPolicy={​
"Statement" : [​
{​
"Effect": "Allow",​
"Principal": "*",​
"Action": "*",​
"Resource": "*"​
}​
]​
}&Tags.1.Key=k1&Tags.1.Value=v1​
Host: privatelink.cn-guangzhou.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-guangzhou/privatelink/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "CreateVpcGatewayEndpoint",​
"Version": "2020-04-01",​
"Service": "privatelink",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"EndpointId": "gwep-273yuq6q7bgn47fap8squ****",​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****"​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
IdempotentParameterMismatch​
The 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。​
400​
InvalidClientToken.Malformed​
The specified ClientToken is malformed.​
指定的 ClientToken 参数格式不合法。​
400​
InvalidDescription.Malformed​
The specified Description is malformed.​
指定的 Description 参数格式不合法。​
400​
InvalidName.Malformed​
The specified Name is malformed.​
指定的 Name 参数格式不合法。​
400​
InvalidPolicy.Action.Malformed​
The specified Policy.Action is malformed.​
指定的 Policy.Action 参数格式不合法。​
400​
InvalidPolicy.Effect.Malformed​
The specified Policy.Effect is malformed.​
指定的 Policy.Effect 参数格式不合法。​
400​
InvalidPolicy.Principal.Malformed​
The specified Policy.Principal is malformed.​
指定的 Policy.Principal 参数格式不合法。​
400​
InvalidPolicy.Resource.Malformed​
The specified Policy.Resource is malformed.​
指定的 Policy.Resource 参数格式不合法。​
400​
InvalidPolicy.Statement.Malformed​
The 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表示缺少的参数名称。​
400​
InvalidProjectName.Malformed​
The specified ProjectName is malformed.​
指定的 ProjectName 参数格式不合法。​
400​
InvalidIncorrectOrder.Malformed​
The specified index order is malformed.​
指定的索引顺序参数格式不合法。​
400​
InvalidTagKey.Malformed​
The specified TagKey is malformed.​
指定的 TagKey 参数格式不合法。​
400​
InvalidTagValue.Malformed​
The specified TagValue is malformed.​
指定的 TagValue 参数格式不合法。​
400​
LimitExceeded.TagOperation​
You've reached the limit on the number of tags that you can operate at a time.​
已达到单次可操作的标签条目数量上限。​
400​
InvalidVpcAccount.Mismatched​
The specified VPC and account don't match.​
指定的私有网络和账户不匹配。​
400​
InvalidPolicy.Condition.Malformed​
The specified Policy.Condition is malformed.​
指定的 Policy.Condition 参数格式不合法。​
400​
InvalidPolicy.ConditionKey.Malformed​
The specified Policy.ConditionKey is malformed.​
指定的 Policy.ConditionKey 参数格式不合法。​
400​
InvalidPolicy.ConditionOperator.Malformed​
The specified Policy.ConditionOperator is malformed.​
指定的 Policy.ConditionOperator 参数格式不合法。​
400​
InvalidPolicy.ConditionValue.Malformed​
The specified Policy.ConditionValue is malformed.​
指定的 Policy.ConditionValue 参数格式不合法。​
400​
InvalidEndpoint.ServiceMisMatch​
The specified endpoint and service don't match.​
指定的终端节点和终端节点服务不匹配。​
404​
InvalidVpc.NotFound​
The specified vpc does not exist.​
指定的私有网络不存在。​
404​
InvalidGatewayEpsvc.NotFound​
The specified GatewayEndpointService does not exist.​
指定的网关终端节点服务不存在。​
404​
InvalidProject.NotFound​
The specified Project does not exist.​
指定的项目不存在。​
409​
InvalidGatewayEp.Conflict​
The GatewayEndpoint of the vpc has been created.​
已创建过该私有网络的网关终端节点。​
412​
IdempotentProcessing​
The request uses the same ClientToken as a previous one that is still in process.​
幂等请求处理中。​
​
​
最近更新时间:2026.10.26 15:10:41
这个页面对您有帮助吗?
有用
有用
无用
无用