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

操作説明

デフォルトでは、セキュリティグループは利用できません。セキュリティグループを使用するには、アカウントマネージャーにご連絡ください。
セキュリティグループが作成されていることを確認してください。セキュリティグループの作成方法の詳細については、「CreateSecurityGroup」をご参照ください。
各 ALB インスタンスは、最大 4 つのセキュリティグループに追加できます。
ALB インスタンスのセキュリティグループを照会するには、GetLoadBalancerAttribute 操作を呼び出します。
LoadBalancerJoinSecurityGroup は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。ListAsynJobs 操作を呼び出して、タスクのステータスを照会できます。
- タスクが Succeeded 状態の場合、ALB インスタンスはセキュリティグループに追加されます。
- タスクが Processing 状態の場合、ALB インスタンスはセキュリティグループに追加中です。この場合、タスクの照会はできますが、他の操作は実行できません。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:LoadBalancerJoinSecurityGroup

none

*LoadBalancer

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SecurityGroupIds	array	必須	セキュリティグループ ID。
	string	任意	セキュリティグループ ID。	sg-m5e7xkprgt1pi1ik****
LoadBalancerId	string	必須	ALB インスタンス ID。	alb-h7kcw4g4nnvtqp****
DryRun	boolean	任意	リクエストを実際に実行せずに、ドライランのみを実行するかどうかを指定します。有効な値： true：ドライランのみを実行します。システムは、パラメーター値の欠落、リクエスト構文の誤り、サービス制限など、リクエストに潜在的な問題がないかチェックします。リクエストがドライランに失敗すると、エラーメッセージが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを送信します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000

レスポンスフィールド

フィールド	型	説明	例
	object	タスクの結果。
JobId	string	非同期タスクの ID。	8fe81f25-79a0-4fa0-9036-f2601fda****
RequestId	string	リクエスト ID。	D3B9AE45-F5DB-58E3-A4B5-EE58F1EC****

例

成功レスポンス

JSONJSON

{
  "JobId": "8fe81f25-79a0-4fa0-9036-f2601fda****",
  "RequestId": "D3B9AE45-F5DB-58E3-A4B5-EE58F1EC****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	ResourceAlreadyAssociated.SecurityGroup	The specified resource of %s is already associated.
400	ResourceQuotaExceeded.SecurityGroupNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.SecurityGroupNotSupport	The operation is not allowed because of %s.
400	OperationDenied.LbAssociatedAclCanNotJoinSecurityGroup	The operation is not allowed because of loadBalancer associated acl can not join security group.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.
404	ResourceNotFound.SecurityGroup	The specified resource %s is not found.

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

変更履歴

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