調(diào)用CreateVpcEndpointService接口，創(chuàng)建終端節(jié)點(diǎn)服務(wù)。
接口說(shuō)明
-
創(chuàng)建終端節(jié)點(diǎn)服務(wù)之前，請(qǐng)確保您已創(chuàng)建支持私網(wǎng)連接的負(fù)載均衡資源。具體操作，請(qǐng)參見(jiàn)創(chuàng)建負(fù)載均衡實(shí)例。
-
CreateVpcEndpointService 接口屬于異步接口，即系統(tǒng)會(huì)返回一個(gè)實(shí)例 ID，但該終端節(jié)點(diǎn)服務(wù)尚未創(chuàng)建完成，系統(tǒng)后臺(tái)任務(wù)仍在進(jìn)行中。您可以調(diào)用 GetVpcEndpointServiceAttribute 查詢終端節(jié)點(diǎn)服務(wù)的創(chuàng)建狀態(tài)：
-
當(dāng)終端節(jié)點(diǎn)服務(wù)處于 Creating 狀態(tài)時(shí)，表示終端節(jié)點(diǎn)服務(wù)正在創(chuàng)建。
-
當(dāng)終端節(jié)點(diǎn)服務(wù)處于 Active 狀態(tài)時(shí)，表示終端節(jié)點(diǎn)服務(wù)創(chuàng)建完成。
-
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| privatelink:CreateVpcEndpointService | create | *VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/**LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}*LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}*NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}*LoadBalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 終端節(jié)點(diǎn)服務(wù)所在的地域 ID。 您可以通過(guò)調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-huhehaote |
| ClientToken | string | 否 | 客戶端 Token，用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值，確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 | 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
| DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求，取值：
| false |
| ServiceDescription | string | 否 | 終端節(jié)點(diǎn)服務(wù)的描述信息。 | This is my EndpointService. |
| AutoAcceptEnabled | boolean | 否 | 是否自動(dòng)接受終端節(jié)點(diǎn)連接，取值：
| false |
| Payer | string | 否 | 付費(fèi)方，取值：
| Endpoint |
| ZoneAffinityEnabled | boolean | 否 | 是否支持連接服務(wù)的終端節(jié)點(diǎn)域名就近解析，取值：
| false |
| ServiceResourceType | string | 否 | 服務(wù)資源類型。取值：
說(shuō)明
不支持訪問(wèn) NLB 的 TCPSSL 類型監(jiān)聽(tīng)。
| slb |
| Resource | array<object> | 否 | 終端節(jié)點(diǎn)服務(wù)資源合集。創(chuàng)建時(shí)最多支持 10 個(gè)資源。創(chuàng)建后可通過(guò)為終端節(jié)點(diǎn)添加服務(wù)資源繼續(xù)添加。 | |
| object | 否 | 終端節(jié)點(diǎn)服務(wù)資源合集。 | ||
| ResourceType | string | 否 | 添加到終端節(jié)點(diǎn)服務(wù)中的服務(wù)資源的類型，一個(gè)終端節(jié)點(diǎn)服務(wù)最多支持添加 20 個(gè)服務(wù)資源。取值：
說(shuō)明
在支持私網(wǎng)連接功能的地域內(nèi)，專有網(wǎng)絡(luò)類型的傳統(tǒng)型負(fù)載均衡 CLB 實(shí)例均支持作為終端節(jié)點(diǎn)服務(wù)的服務(wù)資源。不支持訪問(wèn) NLB 的 TCPSSL 類型監(jiān)聽(tīng)。
| slb |
| ResourceId | string | 否 | 添加到終端節(jié)點(diǎn)服務(wù)中的服務(wù)資源 ID。 | lb-hp32z1wp5peaoox2q**** |
| ZoneId | string | 否 | 可用區(qū) ID。 | cn-huhehaote-a |
ServiceSupportIPv6deprecated | boolean | 否 | 終端節(jié)點(diǎn)服務(wù)是否支持 IPv6 功能。取值：
| false |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmy***** |
| Tag | array<object> | 否 | 標(biāo)簽列表。 | |
| object | 否 | 標(biāo)簽列表。 | ||
| Key | string | 否 | 實(shí)例的標(biāo)簽鍵。最多支持 20 個(gè)標(biāo)簽鍵。一旦傳入該值，則不允許為空字符串。 最多支持 64 個(gè)字符，不能以 | env |
| Value | string | 否 | 實(shí)例的標(biāo)簽值。最多支持 20 個(gè)標(biāo)簽值。一旦傳入該值，可以為空字符串。 最多支持 128 個(gè)字符，不能以 | prod |
| AddressIpVersion | string | 否 | 協(xié)議版本。取值：
說(shuō)明
目前僅后端資源類型為 NLB 的終端節(jié)點(diǎn)服務(wù)支持指定 IP 地址協(xié)議為 DualStack。終端節(jié)點(diǎn)服務(wù)支持雙棧，要求其后端資源也需支持雙棧。
| IPv4 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"ServiceBusinessStatus": "Normal",
"RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
"ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
"ServiceStatus": "Active",
"ServiceDescription": "This is my EndpointService.",
"CreateTime": "2022-01-02T19:11:12Z",
"ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
"ZoneAffinityEnabled": false,
"AutoAcceptEnabled": false,
"ServiceId": "epsrv-hp3vpx8yqxblby3i****",
"ServiceSupportIPv6": false,
"ResourceGroupId": "rg-acfmy*****",
"AddressIpVersion": "IPv4"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | EndpointServiceExist | The specified Endpoint Service already exists. | 當(dāng)前終端節(jié)點(diǎn)服務(wù)已經(jīng)存在。 |
| 400 | AlbNotFound | The specified Alb does not exist. | ALI負(fù)載均衡不存在。 |
| 400 | LoadBalancerNotFound | The specified load balancer does not exist. | 負(fù)載均衡不存在。 |
| 400 | LoadBalancerNotSupportPrivateLink | The specified SLB does not support PrivateLink. | 當(dāng)前負(fù)載均衡不支持Privatelink。 |
| 400 | GenerateResourceIdFailed | Failed to generate ResourceId. | 生成資源ID失敗。 |
| 400 | QuotaMisMatched | The resource you applied for has exceeded the quota. | 申請(qǐng)的資源超過(guò)配額 |
| 400 | VSwitchNotFound | The specified VSwitch does not exist. | 當(dāng)前虛擬交換機(jī)未找到。 |
| 400 | EndpointServicePayerForbidden | The parameter EndpointServicePayer is forbidden. The user is not in the whitelist. | 終端節(jié)點(diǎn)服務(wù)的付費(fèi)類型, 不在白名單中 |
| 400 | NeedOpenProduct | The product is not activated. | 產(chǎn)品未開(kāi)通 |
| 400 | EndpointServiceNotSupportedZone | The specified endpoint service does not support the zone. | 終端節(jié)點(diǎn)服務(wù)不支持當(dāng)前可用區(qū)。 |
| 400 | IllegalParamFormat.%s | The param format of %s is illegal. | 指定的%s格式無(wú)效。請(qǐng)檢查參數(shù)約束，并在修改后重試。 |
| 400 | MissingParam.%s | The param of %s is missing. | 參數(shù)%s缺失。 |
| 400 | ResourceNotFound.NatGateway | The specified resource %s is not found. | 資源%s不存在。 |
| 400 | Mismatch.ResourceType | The %s is mismatched for %s and %s. | %s在%s和%s中不匹配。 |
| 400 | EndpointServiceNotSupportIpv6 | The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6. | 終端節(jié)點(diǎn)服務(wù)不支持IPv6 |
| 400 | OperationDenied.PrivateDomainNotSupport | The operation is not allowed because of PrivateDomainNotSupport. | 由于%s，操作不支持 |
| 400 | Conflict.ServiceName | The ServiceName %s is conflict. | 服務(wù)名稱%s沖突 |
| 400 | InvalidParam.PrivateDnsName | The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com. | PrivateDnsName參數(shù)值非法，需要以aliyun.com, aliyun-inc.com，或者aliyuncs.com結(jié)尾。 |
| 400 | OperationDenied.ZoneAffinityNotSupport | The operation is not allowed because of zone affinity not support. | 不允許操作，因?yàn)椴恢С钟蛎徒馕觥?/span> |
| 400 | OperationDenied.RamPolicyNotSupport | The operation is not allowed because of RamPolicyNotSupport. | 不允許操作，因?yàn)椴恢С謗am策略。 |
| 400 | OperationDenied.ResourceTypeNotSupportDualStack | The specified resource type does not support dualstack. | 服務(wù)后端資源類型不支持雙棧。 |
| 400 | OperationDenied.ServiceResourceIpVersionMismatch | The endpoint service and service resource AddressIpVersion do not match. | 終端節(jié)點(diǎn)服務(wù)與后端資源AddressIpVersion不匹配 |
| 400 | IllegalParam.AddressIpVersion | The specified parameter AddressIpVersion is invalid. | 指定的參數(shù)AddressIpVersion 不符合要求。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-09-18 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-09-12 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2024-03-11 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-09-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-11-30 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |