調用CreateVpcEndpoint，創建服務賬號VPC下的終端節點，用于連接用戶VPC下的終端節點服務，以單向打通網絡。

該API的詳細信息請參見配置實例私網連接。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。

請求語法

POST /openapi/instances/{InstanceId}/vpc-endpoints HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path 是 es-cn-2r429tctl000d****

實例ID。
ClientToken String Query 否 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

用于保證請求的冪等性。由客戶端生成該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字符。
dryRun Boolean Query 否 false

是否只預檢此次請求，取值含義如下：

  • true：發送檢查請求，不會創建終端節點。檢查項包括AccessKey是否有效、RAM用戶的授權情況和是否填寫了必需參數。
  • false（默認值）：立即觸發創建終端節點。
Object Body 否

終端節點服務信息。
serviceId String Body 否 epsrv-hp3xdsq46ael67lo****

您創建的終端節點服務ID。服務VPC側終端節點將要關聯的此服務ID。
zoneId String Body 否 cn-hangzhou-i

您創建的終端節點服務對應的可用區ID。

返回數據

名稱 類型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC47D9

請求ID。
Result Object

返回結果詳情。
serviceId String epsrv-bp1w0p3jdirbfmt6****

終端節點關聯的用戶終端節點服務的ID。
endpointDomain String ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com

終端節點域名，用于連接配置。
endpointId String ep-bp1tah7zbrwmkjef****

服務VPC側終端節點ID。
endpointName String vpcElasticSearchABC

服務VPC側終端節點名稱。

示例

請求示例

POST /openapi/instances/es-cn-2r429tctl000d****/vpc-endpoints HTTP/1.1
Content-Type:application/json

{
  "serviceId" : "epsrv-hp3xdsq46ael67lo****",
  "zoneId" : "cn-hangzhou-i"
}

正常返回示例

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC47D9",
  "Result" : {
    "serviceId" : "epsrv-hp3vpx8yqxblby3i****",
    "endpointName" : "vpcElasticSearchABC",
    "endpointId" : "ep-hp33b2e43fays7s8****",
    "endpointDomain" : "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com"
  }
}

錯誤碼

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