CreateVpcEndpointService API の呼び出しによるエンドポイントサービスの作成 - PrivateLink

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

操作説明

エンドポイントサービスを作成する前に、PrivateLink に対応したロードバランシングリソースを作成する必要があります。詳細については、「関連ドキュメント」をご参照ください。
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 です。リージョン ID を取得するには、DescribeRegions 操作を呼び出します。	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：Classic Load Balancer (CLB)。 alb：Application Load Balancer (ALB)。 nlb：Network Load Balancer (NLB)。 gwlb：Gateway Load Balancer (GWLB)。説明 PrivateLink をサポートするリージョンでは、仮想プライベートクラウド (VPC) 内のすべての CLB インスタンスをエンドポイントサービスのサービスリソースとして使用できます。	slb
ResourceId	string	任意	エンドポイントサービスに追加するサービスリソースの ID です。	lb-hp32z1wp5peaoox2q****
ZoneId	string	任意	ゾーン ID です。	cn-huhehaote-a
RegionId	string	必須	エンドポイントサービスのリージョン ID です。リージョン ID を取得するには、DescribeRegions 操作を呼び出します。	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：IPv4 形式（デフォルト）。 DualStack：デュアルスタック形式。説明 NLB または GWLB インスタンスをバックエンドリソースとして使用するエンドポイントサービスのみ、IP アドレスプロトコルとして DualStack を指定できます。エンドポイントサービスがデュアルスタックをサポートする場合、そのバックエンドリソースもデュアルスタックをサポートしている必要があります。列挙値: IPv4 : IPv4 DualStack : DualStack	IPv4
SupportedRegionList	array	任意
	string	任意

レスポンスフィールド

フィールド	型	説明	例
	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：IPv4 形式。 DualStack：デュアルスタック形式。	IPv4
SupportedRegionSet	array<object>
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string
RegionBusinessStatus	string
SupportedRegionId	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": "",
      "SupportedRegionId": ""
    }
  ]
}

エラーコード

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.

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

変更履歴

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