JoinSecurityGroup - 加入安全性群組 - Elastic Compute Service

本介面用於將一台ECS執行個體或一張彈性網卡加入到指定的安全性群組。

介面說明

說明

該 API 已不推薦使用。推薦您調用 ModifyInstanceAttribute 介面將 ECS 執行個體加入或移除安全性群組；調用 ModifyNetworkInterfaceAttribute 介面將彈性網卡（ENI）加入或移除安全性群組。

該介面不支援同時將執行個體和彈性網卡加入一個安全性群組，即參數InstanceId和NetworkInterfaceId不能同時傳值。
您的安全性群組和執行個體必須屬於同一個阿里雲地區。
您的安全性群組和執行個體的網路類型必須相同。如果網路類型為Virtual Private Cloud，則安全性群組和執行個體必須屬於同一個 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 查看最新的阿里雲地區列表。執行個體加入安全性群組的操作可以不指定地區 ID。彈性網卡加入安全性群組的操作必須指定彈性網卡所在的地區 ID。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

樣本

正常返回樣本

JSON格式

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

異常返回樣本

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.	指定的執行個體和安全性群組不屬於同一個Virtual Private Cloud絡。（包含另外兩種特殊情況：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.	指定的執行個體或者網卡正在建立中，請等待執行個體或網卡建立完成後重試。
500	InternalError	The request processing has failed due to some unknown error.
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	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.	指定的執行個體ID無效。
404	InvalidEniId.NotFound	%s
409	InvalidOperation.Conflict	Request was denied due to conflict with a previous request, please try again later.	請求操作的資源與之前的請求衝突

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。