CreateVpcEndpoint API建立終端節點-私網串連-阿里雲 - PrivateLink

建立終端節點。

介面說明

CreateVpcEndpoint 介面屬於非同步介面，即系統會返回一個執行個體 ID，但該終端節點尚未建立完成，系統後台任務仍在進行中。您可以呼叫 GetVpcEndpointAttribute 查詢終端節點的建立狀態：

當終端節點處於 Creating 狀態時，表示終端節點正在建立中。
當終端節點處於 Active 狀態時，表示終端節點建立完成。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	終端節點所在的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-huhehaote
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	否	是否只預檢此次請求。取值： true：傳送檢查請求，不會建立終端節點。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後返回 HTTP 2xx 狀態碼並直接進行操作。	false
EndpointName	string	否	終端節點名稱。長度為 2~128 個字元，以英文字母或中文開頭，可包含數字、短劃線（-）和底線（_）。	test
EndpointType	string	否	終端節點類型。取值： Interface：表示介面終端節點。您可以新增應用型負載平衡 ALB（ApplicationLoad Balancer）、傳統型負載平衡 CLB（Classic Load Balancer）和網路型負載平衡 NLB（Network Load Balancer）的服務資源類型。 Reverse：表示反向終端節點。您可以新增 VPC NAT 閘道作為服務資源。 GatewayLoadBalancer：表示閘道型負載平衡終端節點。您可以新增閘道型負載平衡 GWLB（Gateway Load Balancer）作為服務資源。說明支援反向終端節點的服務只能由阿里雲和生態合作夥伴提供，預設不支援自行建立，如需自行建立，請聯繫客戶經理申請。	Interface
ZonePrivateIpAddressCount	integer	否	每個可用區 ENI 的私網 IP 的數量。僅取值：1。	1
EndpointDescription	string	否	終端節點描述。描述長度為 2~256 個字元，開頭不能為`http://`和`https://`。	This is my Endpoint.
VpcId	string	是	終端節點所屬的專有網路。	vpc-hp356stwkxg3fn2xe****
ServiceId	string	否	終端節點關聯的終端節點服務。	epsrv-hp3xdsq46ael67lo****
ServiceName	string	否	終端節點關聯的終端節點服務的名稱。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	否	終端節點可用區列表。
	object	否	目前地域下的可用區 ID。系統將在您指定的可用區下建立資源。
VSwitchId	string	否	在可用區內要建立終端節點網卡的交換機。您最多可以設定 10 個交換機。	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	否	終端節點的可用區。您最多可以設定 10 個可用區。	cn-huhehaote-b
ip	string	否	指定終端節點可用區的彈性網卡 IPv4 位址。	192.168.XX.XX
Ipv6Address	string	否	指定終端節點可用區的彈性網卡 IPv6 位址。說明僅 AddressIpVersion 屬性取值為 DualStack 時，該參數才可指定。	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	否	終端節點網卡關聯的安全性群組列表。	sg-hp33bw6ynvm2yb0e****
	string	否	終端節點網卡關聯的安全性群組，安全性群組可以管控 VPC 到終端節點網卡的資料通訊。	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	否	是否開啟託管保護，STS 呼叫方式下生效。取值： true：開啟。開啟託管保護後，只有和建立時相同的使用者才能透過 STS 方式對該終端節點進行修改或者刪除等操作。 false（預設值）：不開啟。	false
RegionId	string	是	終端節點所在的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-huhehaote
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	標籤鍵。	env
Value	string	否	標籤值。	prod
ResourceGroupId	string	否	資源群組 ID。	rg-acfmy*****
PolicyDocument	string	否	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:" ] } } ] }
AddressIpVersion	string	否	協定版本。取值： IPv4：IPv4 類型（預設）。 DualStack：雙棧類型。說明終端節點支援雙棧，要求其連線的終端節點服務及終端節點所處的 VPC 均支援雙棧。	IPv4
ZoneAffinityEnabled	boolean	否	是否支援連線服務的終端節點域名就近解析，取值： true：是。 false（預設值）：否。	false
ServiceRegionId	string	否	終端節點服務所屬的地域 ID。缺省值為目前地域，即您建立終端節點所在地域。	cn-huhehaote
CrossRegionBandwidth	integer	否	跨地域頻寬值，僅當終端節點和終端節點服務跨地域時涉及該參數。單位：Mbps。取值：預設值：中國內地與中國內地跨地域取值 1000，其他情況取值 100。最小值：100。最大值：受限於目前帳號的配額（具體數值請參見配額與限制章節）。說明如需指定該參數，請確保您建立的是跨地域的終端節點。	1000

返回參數

名稱	類型	描述	樣本值
	object
EndpointDomain	string	終端節點域名。	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	請求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTime	string	終端節點的建立時間。	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	終端節點的業務狀態。取值： Normal：正常。 FinancialLocked：欠費鎖定。	Normal
EndpointDescription	string	終端節點描述。	This is my Endpoint.
ServiceId	string	終端節點關聯的終端節點服務的 ID。	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	終端節點狀態。取值： Creating：建立中。 Active：可用。 Pending：修改中。 Deleting：刪除中。	Active
VpcId	string	終端節點所屬的專有網路。	vpc-hp356stwkxg3fn2xe****
EndpointName	string	終端節點名稱。	test
ServiceName	string	終端節點關聯的終端節點服務的名稱。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	終端節點的連線頻寬，單位：Mbps。	200
EndpointId	string	終端節點 ID。	ep-hp33b2e43fays7s8****
ConnectionStatus	string	終端節點連線狀態。取值： Pending：修改中。 Connecting：連線中。 Connected：已連線。 Disconnecting：斷開連線中。 Disconnected：未連線。 Deleting：刪除中。	Disconnected
AddressIpVersion	string	協定版本。取值： IPv4：IPv4 類型（預設）。 DualStack：雙棧類型。	IPv4
ZoneAffinityEnabled	boolean	是否支援連線服務的終端節點域名就近解析，取值： true：是。 false：否。	false
ServiceRegionId	string	終端節點服務所屬的地域 ID。	cn-huhehaote
CrossRegionBandwidth	integer	終端節點的跨地域頻寬值，僅當終端節點和終端節點服務跨地域時涉及該參數。單位：Mbps。	1000

樣本

正常返回樣本

JSON格式

{
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "CreateTime": "2022-01-02T19:11:12Z",
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-hp356stwkxg3fn2xe****",
  "EndpointName": "test",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "ServiceRegionId": "cn-huhehaote",
  "CrossRegionBandwidth": 1000
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
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.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。