指定したセキュリティグループにインスタンスを追加します。

このインターフェイスを呼び出すときは、次の点を考慮してください。

  • セキュリティグループに参加する前に、インスタンスは「停止済み」または「実行中」の状態でなければなりません。

  • 各インスタンスは最大5つのセキュリティグループに参加できます。

  • 各セキュリティグループは、最大1000のインスタンスを管理できます。

  • インスタンスとセキュリティグループは、同じAlibaba Cloud リージョン内になければなりません。

  • インスタンスとセキュリティグループのネットワークタイプが同じである必要があります。ネットワークタイプが Virtual Private Cloud (VPC) の場合には、セキュリティグループとインスタンスは同じ VPC に属している必要があります。それ以外の場合は、エラーInvalidInstanceId.Mismatchが返されます。

リクエストパラメーター

Action String はい このインタフェースの名前。値: JoinSecurityGroup
InstanceId String はい インスタンス ID。DescribeInstances を呼び出して、すべてのインスタンス ID を取得できます。
SecurityGroupId String はい セキュリティグループ ID。DescribeSecurityGroups を呼び出すと、すべてのセキュリティグループ ID を取得できます。

レスポンスパラメーター

すべてはパブリックリターンパラメーターです。詳細については、「パブリックリターンパラメーター」を参照してください。

例

リクエストの例

https://ecs.aliyuncs.com/?Action=JoinSecurityGroup
&InstanceId=i-instance1
&SecurityGroupId=F876FF7BA984
&<Common Request Parameters>

レスポンスの例

XML 形式

<JoinSecurityGroupResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</JoinSecurityGroupResponse>

JSON 形式

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

インタフェースに固有のエラーコードは次のとおりです。詳細については、API のエラー・センターを参照してください。

InvalidInstanceId.Mismatch Specified instance and security group are not in the same VPC. 400 セキュリティグループとインスタンスは、同じ VPC に属している必要があります。
InstanceSecurityGroupLimitExceeded Exceeding the allowed amount of security groups that an instance can be in. 400 インスタンスは最大 5 つのセキュリティグループに参加できます。
MissingParameter The input parameter “InstanceId” that is mandatory for processing this request is not supplied. 400 InstanceIdパラメータを指定する必要があります。
MissingParameter The input parameter “SecurityGroupId” that is mandatory for processing this request is not supplied. 400 SecurityGroupIdパラメータを指定する必要があります。
IncorrectInstanceStatus The current status of the resource does not support this operation. 403 セキュリティグループに参加する前に、インスタンスは「停止」または「実行中」の状態でなければなりません。
InstanceLockedForSecurity The specified operation is denied as your instance is locked for security reasons. 403 セキュリティ上の理由でインスタンスがロックされる場合の API の挙動としてリクエストが拒否されました。
SecurityGroupInstanceLimitExceeded The maximum number of instances in a security group is exceeded. 403 各セキュリティグループは、最大 1000 のインスタンスを管理できます。
InvalidInstanceId.AlreadyExists The specified instance already exists in the specified security group. 403 指定されたインスタンスが指定されたセキュリティグループに参加しました。
OperationDenied The specified operation is denied as your instance is locked for security reasons. 403 セキュリティ上の理由でインスタンスがロックされる場合の API の挙動としてリクエストが拒否されました。
InvalidInstanceId.NotFound The specified InstanceId does not exist. 404 指定されたInstanceIdは存在しません。
InvalidSecurityGroupId.NotFound The specified SecurityGroupId does not exist. 404 指定されたSecurityGroupIdは存在しません。