CreateVpcEndpoint_私网连接_API文档-阿里云OpenAPI开发者门户

接口说明

CreateVpcEndpoint 接口属于异步接口，即系统会返回一个实例 ID，但该终端节点尚未创建完成，系统后台任务仍在进行中。您可以调用 GetVpcEndpointAttribute 查询终端节点的创建状态：

当终端节点处于 Creating 状态时，表示终端节点正在创建中。
当终端节点处于 Active 状态时，表示终端节点创建完成。

流控信息

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

授权信息

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

privatelink:CreateVpcEndpoint	Create	VpcEndpoint acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/* SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId} VSwitch acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId} VPC acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}	privatelink:VpcEndpointServiceId	无

请求参数

字段名称	字段详情
RegionIdstring	终端节点所在的地域 ID。展开详情示例值:cn-huhehaote参考取值来源: DescribeRegions
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRunboolean	是否只预检此次请求。取值：展开详情示例值:false
EndpointNamestring	终端节点名称。展开详情示例值:test参考取值来源: ListVpcEndpoints GetVpcEndpointAttribute
EndpointTypestring	终端节点类型。取值：展开详情示例值:Interface参考取值来源: ListVpcEndpoints GetVpcEndpointAttribute
ZonePrivateIpAddressCountinteger<int64>	每个可用区 ENI 的私网 IP 的数量。仅取值：1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
EndpointDescriptionstring	终端节点描述。展开详情示例值:This is my Endpoint.
VpcIdstring	终端节点所属的专有网络。示例值:vpc-hp356stwkxg3fn2xe****
ServiceIdstring	终端节点关联的终端节点服务。示例值:epsrv-hp3xdsq46ael67lo****参考取值来源: ListVpcEndpointServices CreateVpcEndpointService AddUserToVpcEndpointService
ServiceNamestring	终端节点关联的终端节点服务的名称。示例值:com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****参考取值来源: CreateVpcEndpointService ListVpcEndpointServices
Zonearray<object>	终端节点可用区列表。子级条数 <= 10
SecurityGroupIdarray<string>	终端节点网卡关联的安全组列表。示例值:sg-hp33bw6ynvm2yb0e****子级条数 <= 10
ProtectedEnabledboolean	是否开启托管保护，STS 调用方式下生效。取值：展开详情示例值:false
Tagarray<object>	标签列表。子级条数 <= 21
ResourceGroupIdstring	资源组 ID。示例值:rg-acfmy*****
PolicyDocumentstring	RAM 权限策略。关于策略定义的更多信息，请参见权限策略基本元素。示例值:{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersionstring	协议版本。取值：展开详情示例值:IPv4枚举值:IPv4DualStack

返回参数

字段名称	字段详情
EndpointDomainstring	终端节点域名。示例值:ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestIdstring	请求 ID。示例值:0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTimestring	终端节点的创建时间。示例值:2022-01-02T19:11:12Z
EndpointBusinessStatusstring	终端节点的业务状态。取值：展开详情示例值:Normal
EndpointDescriptionstring	终端节点描述。示例值:This is my Endpoint.
ServiceIdstring	终端节点关联的终端节点服务的 ID。示例值:epsrv-hp3vpx8yqxblby3i****
EndpointStatusstring	终端节点状态。取值：展开详情示例值:Active
VpcIdstring	终端节点所属的专有网络。示例值:vpc-hp356stwkxg3fn2xe****
EndpointNamestring	终端节点名称。示例值:test
ServiceNamestring	终端节点关联的终端节点服务的名称。示例值:com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidthinteger<int64>	终端节点的连接带宽，单位：Mbps。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:200
EndpointIdstring	终端节点 ID。示例值:ep-hp33b2e43fays7s8****
ConnectionStatusstring	终端节点连接状态。取值：展开详情示例值:Disconnected
AddressIpVersionstring	协议版本。取值：展开详情示例值:IPv4

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	EndpointExist	The specified Endpoint already exists.	诊断
400	EndpointZoneDuplicated	The zone is duplicated for the Endpoint.	诊断
400	EndpointServiceNotFound	The specified Service does not exist.	诊断
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	诊断
400	VSwitchNotFound	The specified VSwitch does not exist.	诊断
400	SecurityGroupNotFound	The specified security group does not exist.	诊断
400	VpcTunnelNotFound	The specified VPC tunnel does not exist.	诊断
400	VpcNotFound	The specified VPC does not exist.	诊断
400	GenerateResourceIdFailed	Failed to generate ResourceId.	诊断
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	诊断
400	EndpointMustContainSecurityGroup	The specified endpoint must have at least one security group.	诊断
400	EndpointDuplicated	The endpoint of the service already exists and cannot be created again.	诊断
400	EndpointServiceDeleted	The specified Service is already deleted.	诊断
400	EndpointServiceResourceNotFound	The specified service resource is not found.	诊断
400	SecurityGroupTypeNotSupport	The specified security group type is not supported.	诊断
400	EniIpUnavailable	The specified IP address is unavailable.	诊断
400	EndpointServiceNotAuthorized	The specified endpoint service is not authorized to user.	诊断
400	SecurityGroupTypeOnlySingleTypeSupporteded	The specified security group only support one type.	诊断
400	QuotaExceeded.IpQuotaPerEp	The quota of %s is exceeded, usage %s/%s.	诊断
400	Mismatch.EndpointType	The %s is mismatched for %s and %s.	诊断
400	IncorrectStatus.VpcEndpointService	The status of %s [%s] is incorrect.	诊断
400	CheckServiceLinkRoleError	The ServiceLink role check error.	诊断
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	诊断
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.	诊断
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.	诊断
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.	诊断
400	QuotaExceeded.totalIdleEndpoint	The quota of %s is exceeded, usage %s/%s.	诊断
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.	诊断
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.	诊断
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.	诊断
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.	诊断
400	GatewayLoadBalancerNotSupportSecurityGroup	The gateway load balancer not support security group.	诊断
400	GatewayLoadBalancerZoneCountDeny	The GatewayLoadBalancer zone count not support	诊断
400	OperationDenied.EndpointTypeNotSupportDualstack	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.	诊断
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.	诊断
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.	诊断
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.	诊断
400	IllegalParam.Ip	The specified parameter IP is invalid.	诊断
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.	诊断
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-09-18	变更错误码400
	2024-09-12	变更请求参数Zone 新增请求参数AddressIpVersion 变更返回参数
	2024-05-10	新增请求参数PolicyDocument
	2024-04-08	变更错误码400
	2023-09-26	删除请求参数PolicyDocument
	2023-09-19	变更错误码400
	2023-09-05	变更错误码400 新增请求参数PolicyDocument

1
2
10 条/页