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

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

操作説明

CreateVpcEndpoint は非同期操作です。リクエストを送信すると、システムはインスタンス ID を返しますが、エンドポイントはまだ作成されていません。バックグラウンドノードでの処理が継続中です。 GetVpcEndpointAttribute を呼び出して、エンドポイントの作成ステータスを照会できます。

今すぐお試しください

この 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。	cn-huhehaote。
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値:	false。
EndpointName	string	任意	エンドポイントの名前。	test。
EndpointType	string	任意	エンドポイントタイプ。有効な値:	Interface。
ZonePrivateIpAddressCount	integer	任意	各ゾーンにおける ENI の非公開 IP アドレスの数。値を 1 に設定します。	1
EndpointDescription	string	任意	エンドポイントの説明。	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>	任意	エンドポイントゾーン。
	object	任意	現在のリージョンのゾーン ID。
VSwitchId	string	任意	エンドポイントのネットワークインターフェイス (ENI) を作成するゾーン内の vSwitch。	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	任意	エンドポイントのゾーン。	cn-huhehaote-b。
ip	string	任意	指定されたエンドポイントゾーンにおけるエンドポイントのネットワークインターフェイス (ENI) の IPv4 アドレス。	192.168.XX.XX
Ipv6Address	string	任意	指定されたエンドポイントゾーンにおけるエンドポイントのネットワークインターフェイス (ENI) の IPv6 アドレス。	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	任意	エンドポイントのネットワークインターフェイス (ENI) に関連付けられているセキュリティグループ。	sg-hp33bw6ynvm2yb0e****
	string	任意	エンドポイントのネットワークインターフェイス (ENI) に関連付けられているセキュリティグループ。このセキュリティグループは、VPC からエンドポイントのネットワークインターフェイス (ENI) へのデータ通信を制御します。	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	任意	マネージド保護を有効にするかどうかを指定します。このパラメーターは、セキュリティトークンサービス (STS) を使用してリクエストが行われた場合にのみ効果が得られます。有効な値:	false。
RegionId	string	必須	タグ。	cn-huhehaote
Tag	array<object>	任意	リソースグループの ID。	rg-acfmy*****
	object	任意	タグ。
Key	string	任意	タグキー。	env
Value	string	任意	タグ値。	prod
ResourceGroupId	string	任意	RAM アクセスポリシー。ポリシーフォーマットの詳細については、「ポリシー要素」を参照してください。	{
PolicyDocument	string	任意	プロトコルバージョン。有効な値:	IPv4
AddressIpVersion	string	任意	サービスへの接続時にエンドポイントのドメイン名でゾーンアフィニティをサポートするかどうかを指定します。有効な値:	false。
ZoneAffinityEnabled	boolean	任意	エンドポイントサービスのリージョン ID。デフォルト値は現在のリージョンであり、エンドポイントを作成するリージョンです。	cn-huhehaote。
ServiceRegionId	string	任意	クロスリージョン帯域幅の値。このパラメーターは、エンドポイントとエンドポイントサービスが異なるリージョンにある場合にのみ必須です。単位: Mbps。有効な値:	1000
CrossRegionBandwidth	integer	任意	クロスリージョン帯域幅。このパラメーターは、エンドポイントとエンドポイントサービスが異なるリージョンにある場合にのみ必須です。単位: Mbps。有効な値: デフォルト値: 中国本土内のクロスリージョン接続の場合は 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	エンドポイントが作成された時間。	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	エンドポイントのビジネスステータス。有効な値:	Normal。
EndpointDescription	string	エンドポイントの説明。	This is my Endpoint.
ServiceId	string	エンドポイントに関連付けられているエンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	エンドポイントのステータス。有効な値:	Active。
VpcId	string	エンドポイントが属する VPC。	vpc-hp356stwkxg3fn2xe****
EndpointName	string	エンドポイントの名前。	test。
ServiceName	string	エンドポイントに関連付けられているエンドポイントサービスの名前。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Bandwidth	integer	エンドポイントの接続帯域幅。単位: Mbps。	200
EndpointId	string	エンドポイントの ID。	ep-hp33b2e43fays7s8****
ConnectionStatus	string	エンドポイント接続のステータス。有効な値:	Disconnected。
AddressIpVersion	string	プロトコルバージョン。有効な値:	IPv4
ZoneAffinityEnabled	boolean	サービスへの接続時にエンドポイントのドメイン名でゾーンアフィニティをサポートするかどうかを指定します。有効な値:	false。
ServiceRegionId	string	エンドポイントサービスのリージョン ID。	cn-huhehaote。
CrossRegionBandwidth	integer	エンドポイントのクロスリージョン帯域幅の値。このパラメーターは、エンドポイントとエンドポイントサービスが異なるリージョンにある場合にのみ適用されます。単位: Mbps。	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-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "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.
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.

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

変更履歴

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