創建終端節點。
接口說明
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} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 終端節點所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-huhehaote |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 | 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| EndpointName | string | 否 | 終端節點名稱。 長度為 2~128 個字符，以英文字母或中文開頭，可包含數字、短劃線（-）和下劃線（_）。 | test |
| EndpointType | string | 否 | 終端節點類型。取值：
說明
支持反向終端節點的服務只能由阿里云和生態合作伙伴提供，默認不支持自己創建，如需自己創建，請聯系客戶經理申請。
| Interface |
| ZonePrivateIpAddressCount | long | 否 | 每個可用區 ENI 的私網 IP 的數量。僅取值：1。 | 1 |
| EndpointDescription | string | 否 | 終端節點描述。 描述長度為 2~256 個字符，開頭不能為 | 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 | 否 | 指定終端節點可用區的 IP。 | 192.168.XX.XX |
| Ipv6Address | string | 否 | 指定終端節點可用區的 IPv6 地址。 說明
僅 AddressIpVersion 屬性取值為 DualStack 時，該參數才可指定。
| 2408:4005:34d:****:a58b:62a3:6b55:**** |
| SecurityGroupId | array | 否 | 終端節點網卡關聯的安全組列表。 | |
| string | 否 | 終端節點網卡關聯的安全組，安全組可以管控 VPC 到終端節點網卡的數據通信。 | sg-bp1fg655nh68xyz9**** | |
| ProtectedEnabled | boolean | 否 | 是否開啟托管保護，STS 調用方式下生效。取值：
| false |
| 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 | 否 | 協議版本。取值：
說明
終端節點支持雙棧，要求其連接的終端節點服務及終端節點所處的 VPC 均支持雙棧。
| IPv4 |
返回參數
示例
正常返回示例
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"
}錯誤碼
| 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. | 當前VPC信道未找到。 |
| 400 | VpcNotFound | The specified VPC does not exist. | 當前VPC未找到。 |
| 400 | GenerateResourceIdFailed | Failed to generate ResourceId. | 生成資源ID失敗。 |
| 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. | 指定的IP不可用 |
| 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. | 配額%s已超額度限制，目前已使用%s，配額為%s。 |
| 400 | Mismatch.EndpointType | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
| 400 | IncorrectStatus.VpcEndpointService | The status of %s [%s] is incorrect. | 資源%s [%s]的狀態無效。 |
| 400 | CheckServiceLinkRoleError | The ServiceLink role check error. | ServiceLinkRole校驗錯誤 |
| 400 | ResourceNotEnough.VSwitchIp | The specified resource of VSwitchIp is not enough. | vswitchip數量不夠 |
| 400 | VSwitchStatusNotAllowed | The specified vswitch status is not Available. | 交換機狀態還未可用 |
| 400 | QuotaExceeded.epZonePerEndpoint | The quota of %s is exceeded, usage %s/%s. | 用戶單個endpoint可用區限制 |
| 400 | QuotaExceeded.totalEpPerVpc | The quota of %s is exceeded, usage %s/%s. | 用戶單個VPC終端節點數量限額。 |
| 400 | QuotaExceeded.totalIdleEndpoint | The quota of %s is exceeded, usage %s/%s. | 用戶空閑未連接endpoint總數限制 |
| 400 | OperationDenied.EndpointPolicyNotSupport | The operation is not allowed because of EndpointPolicyNotSupport. | 操作不允許，終端節點策略不支持 |
| 400 | OperationDenied.PrivateDomainStatusNotSupport | The operation is not allowed because of %s. | 由于%s，操作不支持 |
| 400 | OperationDenied.PrivateDomainNotSupport | The operation is not allowed because of PrivateDomainNotSupport. | 由于%s，操作不支持 |
| 400 | DependencyViolation.PrivateDnsName | The specified resource of %s depends on %s, so the operation cannot be completed. | 資源%s依賴于%s，導致操作無法完成 |
| 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. | 終端節點類型不支持雙棧，僅Interface、GatewayLoadBalancer類型支持雙棧。 |
| 400 | OperationDenied.EndpointServiceNotSupportDualstack | The specified endpoint service does not support dualstack. | 終端節點服務不支持雙棧。 |
| 400 | OperationDenied.VSwitchNotSupportDualstack | The specified VSwitch does not support dualstack. | VSwitch不支持雙棧。 |
| 400 | OperationDenied.AddressIpVersionNotSupportSpecifyIpv6 | The AddressIpVersion of the endpoint does not support specifying IPv6 address. | 終端節點的AddressIpVersion不支持指定IPv6地址。 |
| 400 | IllegalParam.Ip | The specified parameter IP is invalid. | 指定的IP地址格式不符合要求。 |
| 400 | IllegalParam.Ipv6Address | The specified parameter Ipv6Address is invalid. | 指定的IPv6地址格式不符合要求。 |
| 400 | IllegalParam.AddressIpVersion | The specified parameter AddressIpVersion is invalid. | 指定的參數AddressIpVersion 不符合要求。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-09-12 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-05-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-04-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-26 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-09-19 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-09-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-11-30 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-11-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-09-20 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-07-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2021-12-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |