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

私网连接

复制全文
下载 pdf
终端节点服务
CreateVpcEndpointService - 创建终端节点服务
复制全文
下载 pdf
CreateVpcEndpointService - 创建终端节点服务
调用CreateVpcEndpointService接口, 创建一个终端节点服务。​
使用说明​
单个终端节点服务在每个可用区默认最多可添加100个服务资源。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:CreateVpcEndpointService​
要执行的操作,取值:CreateVpcEndpointService。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
ServiceType String 可选 示例值:Interface​
终端节点服务的类型。​
  • Interface:接口终端节点服务。​
​
ServiceNameSuffix String 可选 示例值:tos​
终端节点服务的名称后缀。​
设置名称后缀后,系统会按照com.volces.privatelink.<地域ID>.<名称后缀>的格式生成终端节点服务的名称。​
说明​
该参数正在邀测中,如需使用不同名称后缀区分业务,请联系客户经理。​
​
IpAddressVersions.N String 可选 示例值:ipv4​
终端节点服务的IP协议类型。取值为ipv4和ipv6。​
  • 终端节点服务默认为ipv4,若仅为ipv4,请勿传入本参数。​
  • 若终端节点服务为双栈(ipv4&ipv6),则需要传入本参数。传入之前,请确保满足以下条件:​
  • 已开通私网连接服务的IPv6功能。​
  • 指定的服务资源支持双栈。​
  • 参数 - N:表示终端节点服务IP协议类型的序号,取值范围为1~2,两个IP协议类型的序号之间用&分隔。​
  • 当前暂不支持仅传入IPv6。​
说明​
私网连接服务的IPv6功能正在邀测中,如需使用,请联系客户经理。​
​
ServiceResourceType String 可选 示例值:CLB​
服务资源的类型。取值如下:​
  • CLB:传统型负载均衡CLB。​
  • ALB:应用型负载均衡ALB。​
  • NLB:网络型负载均衡NLB。​
说明​
私网连接支持ALB、NLB类型服务资源的功能正在邀测中,如需使用,请联系客户经理。​
​
Resources.N.ResourceId String 必选 示例值:clb-bp1o94dp5i6ea****​
待添加到终端节点服务中的服务资源ID。​
您可以调用DescribeLoadBalancers接口,获取CLB实例的ID。​
  • N:表示服务资源的序号,取值范围为1~20。​
  • 多个服务资源间使用&分隔。​
​
Resources.N.ZoneIds.N String 可选 示例值:cn-guangzhou-a​
负载均衡提供服务的可用区。​
  • ServiceResourceType取值为ALB时,该参数为必填。​
  • 第一个N:表示资源的序号,取值范围为1~20。​
  • 第二个N:表示资源提供服务的可用区序号,取值范围为1~服务支持的最大可用区数。​
  • ServiceResourceType取值为CLB时,无需填写该参数,默认使用CLB实例的主可用区。​
​
AutoAcceptEnabled Boolean 可选 示例值:false​
是否自动接受终端节点连接。取值如下:​
  • true:终端节点服务自动接受终端节点连接。​
  • false(默认值):终端节点服务不会自动接受终端节点连接,需要调用EnableVpcEndpointConnection接口手动接受。​
​
PrivateDNSEnabled Boolean 可选 示例值:false​
是否为终端节点服务启用私有DNS名称。​
  • false(默认值):不启用。​
  • true:启用。​
​
PrivateDNSType String 可选 示例值:public​
私有DNS名称的域名类型。​
  • public(默认值):公网。​
说明​
参数PrivateDNSEnabled取值为true时,该参数生效。​
​
PrivateDNSName String 可选 示例值:www.example.com​
私有DNS名称,即通过私网连接访问服务时希望使用的自定义域名,仅支持公网域名。​
公网域名不支持传入已配置全局解析的内网域名,以及私网连接使用的域名(包括终端节点服务域名和终端节点域名)。​
说明​
  • 参数PrivateDNSEnabled取值为true时,必须传入该参数。​
  • 若传入域名为泛域名 *.www.example.com,则该泛域名及其根域名 www.example.com 均支持解析。​
​
ClientToken String 可选 示例值:123e4567-e89b-12d3-a456-42665544****​
客户端Token,用于保证请求的幂等性。​
  • 该参数值由客户端自动生成,确保不同请求的取值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
  • 取值仅支持ASCII字符,最大不超过64个字符。​
  • 未指定该参数值时,不进行幂等校验。​
​
Description String 可选 示例值:EndpointService​
终端节点服务的描述,默认值为空字符串。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
​
ProjectName String 可选 示例值:default​
终端节点服务所属项目的名称。​
​
Tags.N.Key String 可选 示例值:k1​
终端节点服务用户标签的标签键。​
  • 长度限制为1~128个字符。​
  • 大小写敏感,不能以volc:或sys:的任意大小写组合开头。​
  • 不能以空格开头或结尾。​
  • 允许包含字母、数字、空格()、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。​
说明​
同一资源的标签键不允许重复。​
​
Tags.N.Value String 可选 示例值:v1​
终端节点服务用户标签的标签值。​
  • 长度限制为0~255个字符。​
  • 大小写敏感,不能以空格开头或结尾。​
  • 允许包含字母、数字、空格()、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。​
说明​
如果传入该参数,则必须先传入Tags.N.Key。​
​
SupportedRegions.N String 可选 示例值:cn-beijing​
选择服务发布地域的ID。​
  • 参数-N:表示地域 ID的序号。N的取值范围为1~20。​
  • 多个地域 ID之间用&分隔。​
  • 系统自动判定是否传入发起请求的地域,若未传入,则自动补充发起请求的地域。​
​
​
​
返回参数​
RequestId String 示例值:0ED8D006-F706-4D23-88ED-E11ED28D****​
请求ID。​
​
ServiceId String 示例值:epsvc-2fe630gurkl37k5gfuy33****​
终端节点服务的ID。​
​
​
​
请求示例​
​
GET /?Action=CreateVpcEndpointService&Version=2020-04-01&ServiceType=Interface&ServiceNameSuffix=tos&IpAddressVersions.1=ipv4&IpAddressVersions.2=ipv6&ServiceResourceType=CLB&Resources.1.ResourceId=clb-bp1o94dp5i6ea****&Resources.2.ResourceId=clb-bp1b6c719dfa08ex****&Resources.1.ZoneIds.1=cn-guangzhou-a&Resources.1.ZoneIds.2=cn-guangzhou-b&AutoAcceptEnabled=false&PrivateDNSEnabled=false&PrivateDNSType=public&PrivateDNSName=www.example.com&ClientToken=123e4567-e89b-12d3-a456-42665544****&Description=EndpointService&ProjectName=default&Tags.1.Key=k1&Tags.2.Key=k2&Tags.1.Value=v1&Tags.2.Value=v2 HTTP/1.1​
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": "CreateVpcEndpointService",​
"Version": "2020-04-01",​
"Service": "privatelink",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",​
"ServiceId": "epsvc-2fe630gurkl37k5gfuy33****"​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
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​
InvalidDescription.Malformed​
The specified Description is malformed.​
指定的参数Description格式不合法。​
400​
InvalidResource.Disorder​
The specified resource index orders are malformed.​
指定的资源条目的序号不合法。​
400​
InvalidServiceResource.Malformed​
The specified ServiceResource is malformed.​
指定的 ServiceResource 参数格式不合法。​
400​
InvalidServiceResourceType.Malformed​
The specified ServiceResourceType is malformed.​
指定的参数ServiceResourceType格式不合法。​
400​
InvalidClientToken.Malformed​
The specified ClientToken is malformed.​
指定的 ClientToken 参数格式不合法。​
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​
InvalidResource.Conflict​
The specified resource is duplicated.​
指定的资源重复。​
400​
ErrPrivateLinkServiceNotSupportedZone​
The PrivateLink service does not support the zone.​
终端节点服务不支持添加该可用区的服务资源。​
400​
InsufficientIpInSubnet​
The specified subnet does not contain enough free private IP addresses to fulfill your request.​
指定子网下可用IP不足。​
400​
LimitExceeded.PrivateIpsPerEni​
You've reached the limit on the number of private IPs per ENI that you can assign.​
已达到网卡可分配的辅助IP的数量上限。​
400​
LimitExceed.ServiceResourceNumber​
You've reached the limit on the number of service resources that you can operate.​
已达到单次可操作的服务资源的数量上限。​
400​
QuotaExceed.EndpointServiceNumber​
You've reached the limit on the number of endpoint service instances that you can create.​
已达到可创建终端节点服务实例数量的配额上限。​
400​
QuotaExceeded.SecurityGroup​
The number of security groups bound to the ENI exceeded quota.​
已达到当前网卡可绑定安全组的数量上限。​
400​
QuotaExceeded.EniSecurityGroup​
You've reached the limit on the number of elastic network interfaces that a security group can associate.​
已达到安全组可关联的弹性网卡数量上限​
400​
QuotaExceeded.SecurityGroupIp​
The number of IP addresses bound to the security group exceeded quota.​
已达到安全组可绑定IP地址的数量上限。​
400​
QuotaExceed.ServiceResourceEachZone​
You've reached the limit on the number of service resources in the zone that you can create.​
已达到单个可用区可创建服务资源的数量的配额上限。​
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​
InvalidAccountServiceNameMapping.InvalidStatus​
The specified account service name mapping is not in the correct status for the request.​
指定的服务名称映射表的状态无法响应该请求。​
400​
InvalidPrivateDNSEnabled.PrivateDNSNameMismatch​
The specified PrivateDNSEnabled and PrivateDNSName are mismatched.​
指定的参数私有DNS是否开启与私有DNS名称无法匹配。​
400​
InvalidPrivateDNSName.Malformed​
The specified PrivateDNSName is malformed.​
指定的 PrivateDNSName 参数格式不合法。​
400​
InvalidServiceNameSuffix.Malformed​
The specified ServiceNameSuffix is malformed.​
指定的 ServiceNameSuffix 参数格式不合法。​
400​
ServiceNameSuffixExist​
The specified service name suffix already exists.​
指定的服务名称后缀已经存在。​
400​
InvalidPrivateDNSEnabled.PrivateDNSTypeMismatch​
The specified PrivateDNSEnabled and PrivateDNSType are mismatched.​
指定的参数 私有DNS是否启用 与 私有DNS类型 无法匹配。​
400​
InvalidPrivateDNSType.Malformed​
The specified PrivateDNSType is malformed.​
指定的 PrivateDNSType 参数格式不合法。​
400​
InvalidIpAddressVersions.Conflict​
The specified IpAddressVersions parameter is duplicated.​
指定的IpAddressVersions重复。​
400​
InvalidServiceResourceStatus.IPVersionMismatch​
The specified service resource can not support the EndpointService ipAddressVersion that you want.​
当前服务资源不支持所指定的终端节点服务IP地址类型。​
400​
InvalidIpAddressVersions.Malformed​
The specified IpAddressVersions is malformed.​
指定的 IpAddressVersions 参数格式不合法。​
400​
ServiceLinkRoleNotAuthorized​
The service role for PrivateLink has not been authorized.​
请先授权私网连接的服务关联角色。​
400​
InvalidLocation.Intercepted​
The specified action has been intercepted by location.​
当前账号无指定地域的操作权限,请开通白名单。​
400​
InvalidApplicationLoadBalancer.InvalidZoneInfo​
The specified Application LoadBalancer zone attributes is invalid.​
指定的应用型负载均衡的可用区信息非法。​
400​
InvalidZoneforALB.conflict​
The application load balancer does not support the zone.​
指定的应用型负载均衡实例不支持该可用区。​
400​
InvalidPrivateDNSType.ServiceOwnerMismatch​
The specified service owner can not support the EndpointService PrivateDNS type that you want.​
当前服务主体不支持所指定的私有DNS类型。​
403​
Forbidden​
You are not authorized to perform operations on the specified service.​
无权限对指定服务进行操作。​
404​
InvalidProject.NotFound​
The specified Project does not exist.​
指定的项目不存在。​
404​
InvalidResource.NotFound​
The specified resource does not exist.​
指定的资源不存在。​
404​
InvalidServiceNameSuffix.NotFound​
The specified ServiceNameSuffix does not exist.​
指定的服务名称后缀不存在。​
412​
IdempotentProcessing​
The request uses the same ClientToken as a previous one that is still in process.​
幂等请求处理中。​
​
​
最近更新时间:2026.10.28 10:47:35
这个页面对您有帮助吗?
有用
有用
无用
无用