UpdateVpcEndpointAttribute を使用して VPC エンドポイントプロパティを変更 - PrivateLink - Alibaba Cloud - PrivateLink

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

操作説明

UpdateVpcEndpointAttribute 操作は、同一の 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:UpdateVpcEndpointAttribute

update

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	変更するエンドポイントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	eu-west-1
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値: true: ゲートウェイエンドポイント属性の更新操作を実行せずに、チェックリクエストを送信します。システムは、パラメーター値の欠落、不正なリクエストフォーマット、サービス制限などの潜在的な問題をチェックします。ドライランに失敗した場合、エラーコードが返されます。ドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false（デフォルト）: 通常のリクエストを送信します。ドライランに成功した場合、HTTP 2xx 状態コードが返され、操作が実行されます。	true
EndpointId	string	必須	変更するエンドポイントの ID。	ep-hp33b2e43fays7s8****
EndpointName	string	任意	エンドポイントの名前。名前は 2～128 文字で、英字、数字、ハイフン（-）、アンダースコア（_）を含めることができます。名前は英字または中国語の文字で始まる必要があります。	test
EndpointDescription	string	任意	エンドポイントの説明。説明は 2～256 文字で、`http://` または `https://` で始めることはできません。	This is my Endpoint.
RegionId	string	必須	変更するエンドポイントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	eu-west-1
PolicyDocument	string	任意	RAM アクセスポリシー。ポリシー定義のフォーマットの詳細については、ポリシー要素を参照してください。	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	任意	プロトコルバージョン。有効な値: IPv4: IPv4。 DualStack: デュアルスタック。説明エンドポイントのデュアルスタックを有効にするには、エンドポイントに接続されたエンドポイントサービスとエンドポイントが存在する VPC の両方がデュアルスタックをサポートしている必要があります。	IPv4
ZoneAffinityEnabled	boolean	任意	接続されたサービスのエンドポイントドメイン名に対して最寄りアクセスを有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。	false
ResetPolicy	boolean	任意	ポリシーをデフォルトポリシーにリセットします。	true
CrossRegionBandwidth	integer	任意	クロスリージョン帯域幅。このパラメーターは、エンドポイントとエンドポイントサービスが異なるリージョンにある場合にのみ必須です。単位: Mbit/s。有効な値のフォーマット: 最小値: 100。最大値: 現在のアカウントのクォータによって制限されます。詳細については、クォータと制限を参照してください。説明このパラメーターを指定する前に、エンドポイントがクロスリージョンエンドポイントであることを確認してください。	1000

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

例

成功レスポンス

JSONJSON

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	OperationDenied.EndpointProtected	The operation is not allowed because of EndpointProtected.
400	EndpointNotFound	The specified Endpoint does not exist.
400	EndpointOperationDenied	The specified operation of endpoint is not allowed.
400	EndpointLocked	The specified Endpoint is locked.
400	EndpointConnectionOperationDenied	The endpoint is being connected.
400	EndpointServiceDeleted	The specified Service is already deleted.
400	EndpointProtected	The specified Endpoint is protected.
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	OperationDenied.NotSupportDualStackSwitchToIpv4	AddressIpVersion does not support switching from DualStack to IPv4.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.

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

変更履歴

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