すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:CreateVpcEndpoint

最終更新日:Mar 17, 2025

CreateVpcEndpoint を呼び出して、サービスアカウント VPC の下にエンドポイントを作成し、ユーザー VPC の下のエンドポイントサービスに接続して、一方向にネットワークに接続します。

この API 操作の詳細については、「インスタンスへのプライベート接続を構成する」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、共通リクエストパラメーターに関するトピックをご参照ください。

リクエスト構文

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

リクエストパラメーター

パラメーター タイプ 位置 必須 説明
InstanceId String Path Yes es-cn-2r429tctl000d****

インスタンス ID。

ClientToken String Query No 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

dryRun Boolean Query No false

このリクエストのみを事前チェックするかどうかを指定します。有効な値:

  • true: チェックリクエストが送信され、エンドポイントは作成されません。 システムは、AccessKey ペアが有効かどうか、RAM ユーザーが承認されているかどうか、および必要なパラメーターが設定されているかどうかを確認します。
  • false (デフォルト): エンドポイントはすぐに作成されます。
Object Body No

エンドポイントサービスに関する情報。

serviceId String Body No epsrv-hp3xdsq46ael67lo****

作成したエンドポイントサービスの ID。 サービス VPC 側エンドポイントに関連付けるこのサービスの ID。

zoneId String Body No 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"
  }
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。