PrivateLink エンドポイントサービス属性の更新 - PrivateLink - Alibaba Cloud - PrivateLink

エンドポイントサービスの属性を変更します。

操作説明

エンドポイントサービスの属性を変更する前に、エンドポイントサービスが Active 状態であることを確認してください。 GetVpcEndpointServiceAttribute 操作を呼び出して、エンドポイントサービスのサービスステータスをクエリできます。
UpdateVpcEndpointServiceAttribute 操作は、同一の Alibaba Cloud アカウント内でのエンドポイントサービス属性の同時変更をサポートしていません。

今すぐお試しください

この 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:UpdateVpcEndpointServiceAttribute

update

*VpcEndpointService

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	エンドポイントサービスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken パラメーターは ASCII 文字のみをサポートしています。	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値: true: ドライランのみを実行します。システムは、パラメーター値の欠落、不正なリクエスト構文、サービスの使用制限など、リクエストの潜在的な問題をチェックします。ドライランに失敗した場合、エラーコードが返されます。ドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): ドライランを実行し、実際のリクエストを実行します。ドライランに成功した場合、HTTP 2xx 状態コードが返され、リソースの属性が変更済みになります。	false
ServiceId	string	必須	エンドポイントサービスの ID。	epsrv-hp3vpx8yqxblby3i****
ServiceDescription	string	任意	エンドポイントサービスの説明。	This is my EndpointService.
AutoAcceptEnabled	boolean	任意	エンドポイント接続を自動的に受け入れるかどうかを指定します。有効な値: true: エンドポイント接続を自動的に受け入れます。 false: エンドポイント接続を自動的に受け入れません。	false
ConnectBandwidth	integer	任意	デフォルトの帯域幅制限。デフォルト値: 3072。単位: Mbit/s。有効な値: 100 ～ 10240。説明デフォルトの帯域幅制限の設定項目は、サービスリソースが Classic Load Balancer (CLB) インスタンスまたは Application Load Balancer (ALB) インスタンスの場合にサポートされます。サービスリソースが Network Load Balancer (NLB) インスタンスの場合、接続帯域幅は設定できません。	3072
ZoneAffinityEnabled	boolean	任意	エンドポイントサービスに接続されたエンドポイントのドメイン名を最寄りアクセスポイントに解決するかどうかを指定します。有効な値: true (デフォルト): はい。 false: いいえ。	true
RegionId	string	必須	エンドポイントサービスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ServiceSupportIPv6 `deprecated`	boolean	任意	エンドポイントサービスが IPv6 をサポートするかどうかを指定します。有効な値: true: はい。 false (デフォルト): いいえ。	false
AddressIpVersion	string	任意	プロトコルバージョン。有効な値: IPv4: IPv4。 DualStack: デュアルスタック。説明現在、バックエンドリソースタイプが NLB または GWLB のエンドポイントサービスのみが、IP アドレスプロトコルを DualStack に設定することをサポートしています。	IPv4
AddSupportedRegionSet	array	任意	エンドポイントサービスに追加するリモートリージョンのリスト。
	string	任意	エンドポイントサービスに追加するリモートリージョンの ID。	cn-huhehaote
DeleteSupportedRegionSet	array	任意	エンドポイントサービスから削除するリモートリージョンのリスト。
	string	任意	エンドポイントサービスから削除するリモートリージョンの ID。	cn-beijing

レスポンスフィールド

フィールド	型	説明	例
	object	リクエスト ID。
RequestId	string	リクエスト ID。	8D8992C1-6712-423C-BAC5-E5E817484C6B

例

成功レスポンス

JSONJSON

{
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	EndpointServiceNotFound	The specified Service does not exist.
400	EndpointServiceLocked	The specified Service is locked.
400	EndpointServiceOperationDenied	The specified operation of endpoint service is not allowed.
400	IllegalParamFormat.%s	The param format of %s is illegal.
400	OperationDenied.PrivateServiceDomainBusinessStatus	The operation is not allowed because of PrivateServiceDomainBusinessStatus.
400	MissingParam.%s	The param of %s is missing.
400	ServiceResourceNotSupportIpv6	The resource is not support ipv6.
400	EndpointServiceDowngradeNotAllowed	The EndpointService is not allowed for downgrade.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
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.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.
400	EndpointServiceConnectionDependence	There are connections between the endpoint service and the dualstack endpoint, the endpoint service address ip version not support switching from dualstack to ipv4.

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

変更履歴

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