CreateVpcEndpointService API の呼び出しによるエンドポイントサービスの作成 - PrivateLink - Alibaba Cloud - 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

*VpcEndpointサービス

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 を呼び出して、最新のリージョンリストを照会できます。	cn-huhehaote
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用できます。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値: true: ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービス制限などの潜在的な問題についてリクエストをチェックします。ドライランに失敗した場合、エラーコードが返されます。ドライランに成功した場合、DryRunOperation エラーコードが返されます。 false (デフォルト): ドライランを実行し、実際のリクエストを実行します。ドライランに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	false
ServiceDescription	string	任意	エンドポイントサービスの説明。	This is my EndpointService.
AutoAcceptEnabled	boolean	任意	エンドポイント接続を自動的に受け入れるかどうかを指定します。有効な値: true: エンドポイント接続を自動的に受け入れます。 false (デフォルト): エンドポイント接続を自動的に受け入れません。	false
Payer	string	任意	支払者。有効な値: Endpoint: サービス利用者。 EndpointService: サービスプロバイダー。	Endpoint
ZoneAffinityEnabled	boolean	任意	エンドポイントサービスのエンドポイントドメイン名に対してゾーンアフィニティをサポートするかどうかを指定します。有効な値: true: サポートします。 false (デフォルト): サポートしません。	false
ServiceResourceType	string	任意	EPS リソースタイプ。有効な値: 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	任意	エンドポイントサービスに追加する EPS リソースタイプ。エンドポイントサービスには最大 20 個のサービスリソースを追加できます。有効な値: slb: Classic Load Balancer (CLB)。 alb: Application Load Balancer (ALB)。 nlb: Network Load Balancer (NLB)。 gwlb: Gateway Load Balancer (GWLB)。	slb
ResourceId	string	任意	エンドポイントサービスに追加するサービスリソースの ID。	lb-hp32z1wp5peaoox2q****
ZoneId	string	任意	ゾーン ID。	cn-huhehaote-a
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	任意	プロトコルバージョン。有効な値: IPv4: IPv4 (デフォルト)。 DualStack: デュアルスタック。説明バックエンドリソースタイプが nlb または gwlb であるエンドポイントサービスのみがデュアルスタックをサポートします。エンドポイントサービスがデュアルスタックをサポートする場合、バックエンドリソースもデュアルスタックをサポートする必要があります。	IPv4
SupportedRegionList	array	任意	エンドポイントサービスでサポートされているリージョンのリスト。サービス利用者は、このリスト内のリージョンからエンドポイント接続を作成できます。
	string	任意	エンドポイントサービスでサポートされているリージョンの ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	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	エンドポイントサービスが作成された時間。時間は YYYY-MM-DDTHH:mm:ssZ フォーマットで、協定世界時 (UTC) で表示されます。	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	プロトコルバージョン。有効な値: IPv4: IPv4。 DualStack: デュアルスタック。	IPv4
SupportedRegionSet	array<object>	エンドポイントサービスでサポートされているリージョンのリスト。サービス利用者は、このリスト内のリージョンからエンドポイント接続を作成できます。
	object
ServiceRegionId `deprecated`	string	[非推奨] エンドポイントサービスでサポートされているリージョン ID。代わりに SupportedRegionId を使用してください。
RegionServiceStatus	string	エンドポイントサービスでサポートされているリージョンのステータス。有効な値: Pending: 変更済み。 Available: 利用可能。 Deleting: 削除中。 Failed: 失敗した。 Closed: クローズ。	Available
RegionBusinessStatus	string	エンドポイントサービスでサポートされているリージョンのビジネスステータス。有効な値: Normal: 法線。 FinancialLocked: 滞納ロック。	Normal
SupportedRegionId	string	エンドポイントサービスでサポートされているリージョンの ID。	cn-hangzhou

例

成功レスポンス

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": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	EndpointServiceExist	The specified Endpoint Service already exists.	エンドポイントサービスはすでに存在します。
400	AlbNotFound	The specified Alb does not exist.	ALI ロードバランシングインスタンスが存在しません。
400	LoadBalancerNotFound	The specified load balancer does not exist.	ロードバランサーインスタンスが存在しません。
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.	現在のロードバランサーインスタンスは PrivateLink をサポートしていません。
400	GenerateResourceIdFailed	Failed to generate ResourceId.	リソース ID の生成に失敗しました。
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.	指定された %s のフォーマットが無効です。パラメーターの制約を確認して、再試行してください。
400	MissingParam.%s	The param of %s is missing.	%s パラメーターが不足しています。
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.	%s が %s と %s の間で一致しません。
400	EndpointServiceNotSupportIpv6	The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.	エンドポイントサービスは IPv6 をサポートしていません。
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.	%s のため、この操作はサポートされていません。
400	Conflict.ServiceName	The ServiceName %s is conflict.	サービス名 %s が既存のサービス名と競合しています。
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.	RAM ポリシーがサポートされていないため、この操作は許可されていません。
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.	サービスのバックエンドリソースタイプはデュアルスタックをサポートしていません。
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.	エンドポイントサービスの AddressIpVersion がバックエンドリソースと一致しません。
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	指定された AddressIpVersion パラメーターが要件を満たしていません。
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.	指定された ALB インスタンスはサポートされていません。

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

変更履歴

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