本接口用于將一臺ECS實例或一張彈性網卡加入到指定的安全組。
接口說明
說明
該 API 已不推薦使用。推薦您調用 ModifyInstanceAttribute 接口將 ECS 實例加入或移除安全組；調用 ModifyNetworkInterfaceAttribute 接口將彈性網卡（ENI）加入或移除安全組。
- 該接口不支持同時將實例和彈性網卡加入一個安全組，即參數
InstanceId和NetworkInterfaceId不能同時傳值。 - 您的安全組和實例必須屬于同一個阿里云地域。
- 您的安全組和實例的網絡類型必須相同。如果網絡類型為專有網絡 VPC，則安全組和實例必須屬于同一個 VPC。
- 加入安全組之前，實例必須處于已停止（Stopped）或者運行中（Running）狀態。
- 一臺實例或一張彈性網卡最多可以加入五個安全組。更多信息，請參見安全組使用限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ecs:JoinSecurityGroup | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}*SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SecurityGroupId | string | 是 | 安全組 ID。您可以調用 DescribeSecurityGroups 查看您可用的安全組。 | sg-bp67acfmxazb4p**** |
| InstanceId | string | 否 | 實例 ID。 說明
當該參數傳入值時， NetworkInterfaceId必須為空。
| i-bp67acfmxazb4p**** |
| NetworkInterfaceId | string | 否 | 彈性網卡 ID。 說明
當該參數傳入值時， InstanceId必須為空。
| eni-bp13kd656hxambfe**** |
| RegionId | string | 否 | 地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。
| cn-hangzhou |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InstanceSecurityGroupLimitExceeded | Exceeding the allowed amount of security groups that an instance can be in. | 加入安全組失敗，該實例加入的安全組數量已達到上限。 |
| 400 | InvalidInstanceId.Mismatch | Specified instance and security group are not in the same VPC. | 指定的實例和安全組不屬于同一個虛擬專有網絡。（包含另外兩種特殊情況：1.實例不屬于VPC類型，安全組屬于VPC類型；2.實例屬于VPC類型，安全組不屬于VPC類型。） |
| 400 | InvalidInstanceId.Malformed | The specified parameter "InstanceId" is not valid. | - |
| 400 | InvalidOperation.NotSupportEnterpriseGroup | The specified instance type doesn't support enterprise level security group. | - |
| 400 | InvalidOperation.MultiGroupType | The specified instance can't join different types of security group. | 指定的實例無法加入不同類型的安全組 |
| 400 | InvalidOperation.InvalidEniState | %s | 彈性網卡當前的狀態不支持此操作。 |
| 400 | InvalidOperation.EniAndGroupNotBelongSameUser | %s | - |
| 400 | NotBelongUser | %s | 您沒有權限操作此資源，請檢查操作的資源是否正確。 |
| 400 | MissingParameter.RegionId | The specified RegionId should not be null. | RegionId是必選參數。 |
| 400 | InvalidStatus.EniOrInstanceIsBeingCreated | %s. | 指定的實例或者網卡正在創建中，請等待實例或網卡創建完成后重試。 |
| 403 | 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 | SecurityGroupInstanceLimitExceeded | The maximum number of instances in a security group is exceeded. | 該安全組內已有的實例數量已達到最大限制。 |
| 403 | InvalidInstanceId.AlreadyExists | The specified instance already exists in the specified security group. | 指定的實例已經在指定的安全組中。 |
| 403 | SecurityGroupInstanceLimitExceeded | %s | 該安全組內已有的實例數量已達到最大限制。 |
| 403 | AclLimitExceed | %s | 網卡或實例的安全組規則數量超過限額值。 |
| 403 | InstanceSecurityGroupLimitExceeded | %s | 實例綁定的安全組數量達到最大限制。 |
| 403 | InvalidOperation.NetworkInterfaceCountExceeded | The maximum number of NetworkInterface in a enterprise level security group is exceeded. | - |
| 403 | InvalidOperation.ResourceManagedByCloudProduct | %s | 云產品托管的安全組不支持修改操作。 |
| 403 | InvalidOperation.InvalidEniType | %s | 當前彈性網卡的類型不支持此操作。 |
| 403 | InvalidOperation.VpcMismatch | %s | 您的操作無效，請確認該操作中的 VPC 與其它參數是否匹配。 |
| 403 | InvalidOperation.EniServiceManaged | %s | 操作無效。 |
| 403 | InvalidParam.Malformed | %s | - |
| 403 | InvalidParam.EniIdAndInstanceId.Conflict | %s | InstanceId 與 NetworkInterfaceId 兩者沖突。兩個參數不能同時被賦值。 |
| 403 | Forbidden.InstanceIsBeingCreated | The specified instance is being created. | 指定的實例正在創建中。 |
| 404 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | 指定的安全組在該用戶賬號下不存在，請您檢查安全組 ID 是否正確。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的InstanceId不存在。 |
| 404 | InvalidEniId.NotFound | %s | 指定的彈性網卡 ID 不存在。 |
| 404 | InvalidInstanceId.NotFound | The specified parameter InstanceId does not exist. | 指定的實例ID不存在。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |