CreateVpcEndpoint - - Alibaba Cloud ドキュメントセンター

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

操作説明

CreateVpcEndpoint は非同期操作です。リクエストを送信すると、システムはインスタンス 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 Load Balancer (ALB)、Classic Load Balancer (CLB)、および Network Load Balancer (NLB) インスタンスを追加できます。 Reverse：リバースエンドポイント。サービスリソースとして VPC NAT Gateway を追加できます。 GatewayLoadBalancer：Gateway Load Balancer (GWLB) エンドポイント。サービスリソースとして GWLB インスタンスを追加できます。説明リバースエンドポイントをサポートするサービスは、Alibaba Cloud とそのエコシステムパートナーによってのみ提供されます。デフォルトではこれらのサービスを作成できません。これらのサービスを作成するには、アカウントマネージャーにお問い合わせください。	Interface
ZonePrivateIpAddressCount	integer	任意	各ゾーンのエンドポイント Elastic Network Interface (ENI) 用に作成できるプライベート IP アドレスの数。値を 1 に設定します。	1
EndpointDescription	string	任意	エンドポイントの説明。説明は長さが 2～256 文字である必要があり、`http://` または `https://` で始めることはできません。	This is my Endpoint.
VpcId	string	必須	エンドポイントが作成される Virtual Private Cloud (VPC) の ID。	vpc-hp356stwkxg3fn2xe****
ServiceId	string	任意	エンドポイントが関連付けられているエンドポイントサービスの ID。	epsrv-hp3xdsq46ael67lo****
ServiceName	string	任意	エンドポイントが関連付けられているエンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	任意	エンドポイントを作成するゾーン。
	object	任意	現在のリージョン内のゾーンの ID。システムは指定されたゾーンにリソースを作成します。
VSwitchId	string	任意	エンドポイント ENI を作成するゾーン内の vSwitch の ID。最大 10 個の vSwitch ID を指定できます。	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	任意	エンドポイントサービスでサポートされているゾーンの ID。最大 10 個のゾーン ID を指定できます。	cn-huhehaote-b
ip	string	任意	指定されたゾーンのエンドポイントの IP アドレス。	192.168.XX.XX
Ipv6Address	string	任意	指定されたゾーンのエンドポイントの IPv6 アドレス。説明このパラメーターは、AddressIpVersion パラメーターを DualStack に設定した場合にのみ使用できます。	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	任意	エンドポイント ENI に関連付けられているセキュリティグループの ID。	sg-hp33bw6ynvm2yb0e****
	string	任意	エンドポイント ENI が属するセキュリティグループの ID。セキュリティグループは、VPC からエンドポイント ENI へのデータ通信を制御します。	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	任意	マネージド保護を有効にするかどうかを指定します。このパラメーターは、RAM ロールを偽装して操作を実行する場合にのみ有効です。有効な値： true：マネージド保護を有効にします。マネージド保護を有効にすると、エンドポイントを作成したユーザーのみが Security Token Service (STS) トークンを使用してエンドポイントを変更または削除できます。 false (デフォルト)：マネージド保護を無効にします。	false
RegionId	string	必須	エンドポイントのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID を取得します。	cn-huhehaote
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	任意	IP バージョン。有効な値： IPv4 (デフォルト) DualStack 説明デュアルスタック機能を使用するには、関連付けられたエンドポイントサービスとエンドポイントが作成される VPC でこの機能を有効にする必要があります。列挙値: IPv4 : IPv4 DualStack : DualStack	IPv4
ZoneAffinityEnabled	boolean	任意	ゾーンアフィニティを有効にするかどうかを指定します。ゾーンアフィニティを有効にすると、リクエストはクライアントと同じゾーンのエンドポイントにルーティングされます。有効な値： true false (デフォルト)	false

レスポンスフィールド

フィールド	型	説明	例
	object
EndpointDomain	string	エンドポイントのドメイン名。	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTime	string	エンドポイントが作成された時刻。	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 の ID。	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 (デフォルト) DualStack	IPv4
ZoneAffinityEnabled	boolean	ゾーンアフィニティが有効になっているかどうかを示します。有効な値： true false	false
ServiceRegionId	string
CrossRegionBandwidth	integer

例

成功レスポンス

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-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "ServiceRegionId": "",
  "CrossRegionBandwidth": 0
}

エラーコード

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.
400	VpcNotFound	The specified VPC does not exist.
400	GenerateResourceIdFailed	Failed to generate ResourceId.
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.
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.
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.
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.
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.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
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.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.
400	IllegalParam.Ip	The specified parameter IP is invalid.
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.

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

変更履歴

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