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

エンドポイントサービスを作成します。

操作説明

エンドポイントサービスを作成する前に、PrivateLink をサポートする負荷分散リソースが作成されていることを確認してください。詳細については、「SLB インスタンスの作成」をご参照ください。
CreateVpcEndpointService は非同期操作です。リクエストを送信すると、システムはインスタンス ID を返し、バックグラウンドでエンドポイントサービスを作成します。 GetVpcEndpointServiceAttribute 操作を呼び出して、エンドポイントサービスのステータスをクエリできます：
- エンドポイントサービスが 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:CreateVpcEndpointService

create

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	エンドポイントサービスのリージョン ID です。 DescribeRegions 操作を呼び出して、リージョン ID を取得できます。	cn-huhehaote
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントから値を生成して、異なるリクエスト間で値が一意であることを確認します。 ClientToken には ASCII 文字のみを含めることができます。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効値： true：ドライランを実行します。システムは、必須パラメーター、リクエストフォーマット、およびサービス制限を確認します。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、リクエストを送信します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が呼び出されます。	false
ServiceDescription	string	任意	エンドポイントサービスの説明です。	This is my EndpointService.
AutoAcceptEnabled	boolean	任意	エンドポイント接続を自動的に受け入れるかどうかを指定します。有効値： true：エンドポイント接続を自動的に受け入れます。 false (デフォルト)：エンドポイント接続を自動的に受け入れません。	false
Payer	string	任意	支払者。有効値： Endpoint：サービス利用者。 EndpointService：サービスプロバイダー。	Endpoint
ZoneAffinityEnabled	boolean	任意	ゾーンアフィニティを有効にするかどうかを指定します。有効値： true false (デフォルト)	false
ServiceResourceType	string	任意	サービスリソースのタイプ。有効値： slb：Classic Load Balancer (CLB)。 alb：Application Load Balancer (ALB)。 nlb：Network Load Balancer (NLB)。 gwlb：Gateway Load Balancer (GWLB)。説明 NLB インスタンスの TCPSSL リスナーはサポートされていません。	slb
Resource	array<object>	任意	サービスリソース。エンドポイントサービスの作成時に最大 10 個のサービスリソースを追加できます。エンドポイントサービスの作成後、さらにサービスリソースを追加できます。
	object	任意	サービスリソース。
ResourceType	string	任意	サービスリソースのタイプ。エンドポイントサービスには最大 20 個のサービスリソースを追加できます。有効値： slb：CLB。 alb：ALB。 nlb：NLB。 gwlb：GWLB。説明 PrivateLink をサポートするリージョンでは、Virtual Private Cloud (VPC) 内のすべての CLB インスタンスをエンドポイントサービスのサービスリソースとして使用できます。	slb
ResourceId	string	任意	サービスリソースの ID です。	lb-hp32z1wp5peaoox2q****
ZoneId	string	任意	ゾーンの ID です。	cn-huhehaote-a
RegionId	string	必須	エンドポイントサービスのリージョン ID です。 DescribeRegions 操作を呼び出して、リージョン ID を取得できます。	cn-huhehaote
ServiceSupportIPv6 `deprecated`	boolean	任意	エンドポイントサービスが IPv6 をサポートするかどうかを指定します。有効値： true false (デフォルト)	false
ResourceGroupId	string	任意	リソースグループの ID です。	rg-acfmy*****
Tag	array<object>	任意	タグのリストです。
	object	任意	タグのリストです。
Key	string	任意	インスタンスのタグキー。最大 20 個のタグキーを指定できます。タグキーは空の文字列にすることはできません。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。	env
Value	string	任意	インスタンスのタグ値。最大 20 個のタグ値を指定できます。タグ値は空の文字列にすることができます。タグ値の長さは最大 128 文字で、`aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。	prod
AddressIpVersion	string	任意	IP バージョン。有効値： IPv4 (デフォルト) DualStack 説明 NLB または GWLB インスタンスをサービスリソースとして使用するエンドポイントサービスのみがデュアルスタック機能をサポートします。 IP アドレスのバージョンを DualStack に設定する場合、サービスリソースもデュアルスタック機能をサポートしている必要があります。列挙値: IPv4 : IPv4 DualStack : DualStack	IPv4

レスポンスフィールド

フィールド	型	説明	例
	object
ServiceBusinessStatus	string	エンドポイントサービスのビジネスステータス。有効値： Normal：エンドポイントサービスは正常に実行されています。 FinancialLocked：支払い遅延によりエンドポイントサービスがロックされています。	Normal
RequestId	string	リクエスト ID です。	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceName	string	エンドポイントサービスの名前です。	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	エンドポイントサービスのステータス。有効値： Creating：エンドポイントサービスは作成中です。 Pending：エンドポイントサービスは変更中です。 Active：エンドポイントサービスは利用可能です。 Deleting：エンドポイントサービスは削除中です。	Active
ServiceDescription	string	エンドポイントサービスの説明です。	This is my EndpointService.
CreateTime	string	エンドポイントサービスが作成された時刻です。	2022-01-02T19:11:12Z
ServiceDomain	string	エンドポイントサービスのドメイン名です。	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
ZoneAffinityEnabled	boolean	ゾーンアフィニティが有効になっているかどうかを示します。有効値： true false	false
AutoAcceptEnabled	boolean	エンドポイント接続が自動的に受け入れられるかどうかを示します。有効値： true：エンドポイント接続は自動的に受け入れられます。 false：エンドポイント接続は自動的に受け入れられません。	false
ServiceId	string	エンドポイントサービスの ID です。	epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6 `deprecated`	boolean	エンドポイントサービスで IPv6 が有効になっているかどうかを示します。有効値： true false	false
ResourceGroupId	string	リソースグループの ID です。	rg-acfmy*****
AddressIpVersion	string	IP バージョン。有効値： IPv4 DualStack	IPv4
SupportedRegionSet	array<object>
	object
ServiceRegionId	string
RegionServiceStatus	string
RegionBusinessStatus	string

例

成功レスポンス

JSONJSON

{
  "ServiceBusinessStatus": "Normal",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2022-01-02T19:11:12Z",
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "ZoneAffinityEnabled": false,
  "AutoAcceptEnabled": false,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "",
      "RegionBusinessStatus": ""
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	EndpointServiceExist	The specified Endpoint Service already exists.
400	AlbNotFound	The specified Alb does not exist.
400	LoadBalancerNotFound	The specified load balancer does not exist.
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.
400	GenerateResourceIdFailed	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	EndpointServicePayerForbidden	The parameter EndpointServicePayer is forbidden. The user is not in the whitelist.
400	NeedOpenProduct	The product is not activated.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.
400	IllegalParamFormat.%s	The param format of %s is illegal.
400	MissingParam.%s	The param of %s is missing.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.
400	EndpointServiceNotSupportIpv6	The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	Conflict.ServiceName	The ServiceName %s is conflict.
400	InvalidParam.PrivateDnsName	The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.
400	OperationDenied.ZoneAffinityNotSupport	The operation is not allowed because of zone affinity not support.
400	OperationDenied.RamPolicyNotSupport	The operation is not allowed because of RamPolicyNotSupport.
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.

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

変更履歴

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