CreateVpcEndpoint API の呼び出しによる VPC エンドポイントの作成 - PrivateLink - Alibaba Cloud - PrivateLink

エンドポイントを作成します。

操作説明

CreateVpcEndpoint API オペレーションは非同期です。システムはインスタンス ID を返しますが、エンドポイントの作成は完全には完了しておらず、バックグラウンドタスクが進行中です。 GetVpcEndpointAttribute 操作を呼び出して、エンドポイントの作成ステータスをクエリできます。

エンドポイントが Creating 状態の場合、エンドポイントは作成中です。
エンドポイントが Active 状態の場合、エンドポイントは作成済みです。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアント側でパラメーター値を生成して、異なるリクエスト間で値が一意になるようにできます。ClientToken パラメーターは ASCII 文字のみをサポートします。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	任意	このリクエストに対してドライランのみを実行するかどうかを指定します。有効な値: true: ドライランを実行し、エンドポイントを作成しません。システムは、必須パラメーターが指定されているか、リクエストフォーマット、およびサービスの制限をチェックします。ドライランに失敗した場合、対応するエラーが返されます。ドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): 通常のリクエストを送信します。ドライランに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	false
EndpointName	string	任意	エンドポイントの名前。名前は 2～128 文字で、英字または漢字で始める必要があります。数字、ハイフン (-)、アンダースコア (_) を含められます。	test
EndpointType	string	任意	エンドポイントタイプ。有効な値: Interface: インターフェイスエンドポイント。Application ロードバランサー (ALB)、Classic ロードバランサー (CLB)、Network ロードバランサー (NLB) などの EPS リソースタイプを負荷分散用に追加できます。 Reverse: リバースエンドポイント。VPC NAT ゲートウェイをサービスリソースとして追加できます。 GatewayLoadBalancer: Gateway Load Balancer エンドポイント (GWLBe)。Gateway Load Balancer (GWLB) をサービスリソースとして追加できます。説明リバースエンドポイントをサポートするサービスは、Alibaba Cloud およびエコシステムパートナーによってのみ提供されます。デフォルトでは、このようなサービスは作成できません。作成するには、アカウントマネージャーの連絡先を参照してください。	Interface
ZonePrivateIpAddressCount	integer	任意	各ゾーンにおけるエンドポイントのエラスティックネットワークインターフェイス (ENI) の非公開 IP アドレスの数。値を 1 に設定します。	1
EndpointDescription	string	任意	エンドポイントの説明。説明は 2～256 文字で、`http://` または `https://` で始めることはできません。	This is my Endpoint.
VpcId	string	必須	エンドポイントが属する仮想非公開クラウド (VPC)。	vpc-hp356stwkxg3fn2xe****
ServiceId	string	任意	エンドポイントに関連付けられているエンドポイントサービス。	epsrv-hp3xdsq46ael67lo****
ServiceName	string	任意	エンドポイントに関連付けられているエンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	任意	エンドポイントゾーンのリスト。指定されたゾーンはエンドポイントサービスでサポートされている必要があります。サポートされていない場合、EndpointServiceNotSupportedZone エラーが返されます。
	object	任意	現在のリージョンのゾーン ID。システムは、指定されたゾーンにリソースを作成します。
VSwitchId	string	任意	エンドポイント ENI が作成されるゾーンの vSwitch。最大 10 個の vSwitch を指定できます。	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	任意	エンドポイントのゾーン。最大 10 個のゾーンを指定できます。	cn-huhehaote-b
ip	string	任意	指定されたエンドポイントゾーンにおける ENI の IPv4 アドレス。	192.168.XX.XX
Ipv6Address	string	任意	指定されたエンドポイントゾーンにおける ENI の IPv6 アドレス。説明このパラメーターは、AddressIpVersion パラメーターが DualStack に設定されている場合にのみ指定できます。	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	任意	エンドポイント ENI に関連付けられているエンドポイントセキュリティグループのリスト。	sg-hp33bw6ynvm2yb0e****
	string	任意	エンドポイント ENI に関連付けられているエンドポイントセキュリティグループ。セキュリティグループは、VPC からエンドポイント ENI へのデータ通信をコントロールできます。	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	任意	マネージド保護を有効にするかどうかを指定します。このパラメーターは、セキュリティトークンサービス (STS) の呼び出しに対してのみ効果があります。有効な値: true: マネージド保護を有効にします。マネージド保護が有効化されると、エンドポイントを作成したユーザーのみが STS を使用してエンドポイントを変更または削除できます。 false (デフォルト): マネージド保護を無効にします。	false
Tag	array<object>	任意	タグのリスト。
	object	任意	タグのリスト。
Key	string	任意	タグキー。	env
Value	string	任意	タグ値。	prod
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmy*****
PolicyDocument	string	任意	Resource Access Management (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	任意	IP バージョン。有効な値: IPv4: IPv4 (デフォルト)。 DualStack: デュアルスタック。説明エンドポイントでデュアルスタックを使用するには、関連付けられているエンドポイントサービスと、エンドポイントが存在する VPC の両方がデュアルスタックをサポートしている必要があります。	IPv4
ZoneAffinityEnabled	boolean	任意	接続されたサービスのエンドポイントドメイン名に対して最寄りアクセス解像度をサポートするかどうかを指定します。有効な値: true: はい。 false (デフォルト): いいえ。	false
ServiceRegionId	string	任意	エンドポイントサービスのリージョン ID。デフォルト値は現在のリージョン、つまりエンドポイントを作成するリージョンです。	cn-huhehaote
CrossRegionBandwidth	integer	任意	クロスリージョン帯域幅。このパラメーターは、エンドポイントとエンドポイントサービスが異なるリージョンにある場合にのみ必須です。単位: Mbit/s。有効な値: デフォルト値: 中国本土内のクロスリージョン接続の場合は 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	エンドポイントが作成された時間。時間は ISO 8601 規格の YYYY-MM-DDTHH:mm:ssZ フォーマットに従います。時間は協定世界時 (UTC) で表示されます。	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)。	vpc-hp356stwkxg3fn2xe****
EndpointName	string	エンドポイントの名前。	test
ServiceName	string	エンドポイントに関連付けられているエンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	エンドポイントの接続帯域幅。単位: Mbit/s。	200
EndpointId	string	エンドポイント ID。	ep-hp33b2e43fays7s8****
ConnectionStatus	string	エンドポイントのエンドポイント接続ステータス。有効な値: Pending: エンドポイント接続は変更済みです。 Connecting: エンドポイント接続を確立中です。 Connected: エンドポイント接続は確立されています。 Disconnecting: エンドポイント接続を切断中です。 Disconnected: エンドポイント接続は切断されています。 Deleting: エンドポイント接続を削除中です。	Disconnected
AddressIpVersion	string	IP バージョン。有効な値: IPv4: IPv4 (デフォルト)。 DualStack: デュアルスタック。	IPv4
ZoneAffinityEnabled	boolean	接続されたサービスのエンドポイントドメイン名に対して最寄りアクセス解像度がサポートされているかどうかを示します。有効な値: true: はい。 false: いいえ。	false
ServiceRegionId	string	エンドポイントサービスのリージョン ID。	cn-huhehaote
CrossRegionBandwidth	integer	エンドポイントのクロスリージョン帯域幅。このパラメーターは、エンドポイントとエンドポイントサービスが異なるリージョンにある場合にのみ返されます。単位: Mbit/s。	1000

例

成功レスポンス

JSONJSON

{
  "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-hp3vpx8yqxblby3i****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected。",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": true,
  "ServiceRegionId": "cn-huhehaote。",
  "CrossRegionBandwidth": 1000
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
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.	エンドポイントは少なくとも 1 つのセキュリティグループに関連付ける必要があります。
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.	セキュリティグループは 1 つのタイプのみサポートします。
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.	vSwitch の利用可能な IP アドレス数が不足しています。
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.	vSwitch はまだ利用できません。
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.	1 つのエンドポイントあたりのゾーン数が上限に達しています。
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.	1 つの VPC あたりの VPC エンドポイント数がクォータ制限に達しています。
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.	%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.	Gateway Load Balancer タイプではセキュリティグループを設定できません。
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 パラメーターが要件を満たしていません。
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.	指定された ALB インスタンスはサポートされていません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。