文档

JoinSecurityGroup - 将实例加入到指定安全组

更新时间:

调用JoinSecurityGroup将一台ECS实例或一个弹性网卡加入到指定的安全组。

接口说明

说明 该 API 已不推荐使用。推荐您调用 ModifyInstanceAttribute 接口将 ECS 实例加入或移除安全组;调用 ModifyNetworkInterfaceAttribute 接口将弹性网卡(ENI)加入或移除安全组。

调用该接口时,您需要注意:

  • 加入安全组之前,实例必须处于已停止(Stopped)或者运行中(Running)状态。

  • 一台实例最多可以加入五个安全组。

  • 您可以提交工单申请将实例加入更多安全组,最多不能超过 16 个安全组。

  • 每个普通安全组最多能管理 2000 台实例,企业安全组最多能管理 65536 台实例。

  • 您的安全组和实例必须属于同一个阿里云地域。

  • 您的安全组和实例的网络类型必须相同。如果网络类型为专有网络 VPC,则安全组和实例必须属于同一个 VPC。

  • 不支持同时将实例和弹性网卡加入一个安全组,即参数InstanceIdNetworkInterfaceId不能同时传值。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:JoinSecurityGroupWrite
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • SecurityGroup
    acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}
  • ecs:tag

请求参数

名称类型必填描述示例值
SecurityGroupIdstring

安全组 ID。您可以调用 DescribeSecurityGroups 查看您可用的安全组。

sg-bp67acfmxazb4p****
InstanceIdstring

实例 ID。

说明 当该参数传入值时,NetworkInterfaceId必须为空。
i-bp67acfmxazb4p****
NetworkInterfaceIdstring

弹性网卡 ID。

说明 当该参数传入值时,InstanceId必须为空。
eni-bp13kd656hxambfe****
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

  • 实例加入安全组的操作可以不指定地域 ID。
  • 弹性网卡加入安全组的操作必须指定弹性网卡所在的地域 ID。
cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InstanceSecurityGroupLimitExceededExceeding the allowed amount of security groups that an instance can be in.加入安全组失败,该实例加入的安全组数量已达到上限。
400InvalidInstanceId.MismatchSpecified instance and security group are not in the same VPC.指定的实例和安全组不属于同一个虚拟专有网络。(包含另外两种特殊情况:1.实例不属于VPC类型,安全组属于VPC类型;2.实例属于VPC类型,安全组不属于VPC类型。)
400InvalidInstanceId.MalformedThe specified parameter "InstanceId" is not valid.-
400InvalidOperation.NotSupportEnterpriseGroupThe specified instance type doesn't support enterprise level security group.-
400InvalidOperation.MultiGroupTypeThe specified instance can't join different types of security group.-
400InvalidOperation.InvalidEniState%s弹性网卡当前的状态不支持此操作。
400InvalidOperation.EniAndGroupNotBelongSameUser%s-
400NotBelongUser%s您没有权限操作此资源,请检查操作的资源是否正确。
400MissingParameter.RegionIdThe specified RegionId should not be null.RegionId是必选参数。
403IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
403InstanceLockedForSecurityThe specified operation is denied as your instance is locked for security reasons.实例被安全锁定。
403SecurityGroupInstanceLimitExceededThe maximum number of instances in a security group is exceeded.该安全组内已有的实例数量已达到最大限制。
403InvalidInstanceId.AlreadyExistsThe specified instance already exists in the specified security group.指定的实例已经在指定的安全组中。
403SecurityGroupInstanceLimitExceeded%s该安全组内已有的实例数量已达到最大限制。
403AclLimitExceed%s网卡或实例的安全组规则数量超过限额值。
403InstanceSecurityGroupLimitExceeded%s实例绑定的安全组数量达到最大限制。
403InvalidOperation.NetworkInterfaceCountExceededThe maximum number of NetworkInterface in a enterprise level security group is exceeded.-
403InvalidOperation.ResourceManagedByCloudProduct%s云产品托管的安全组不支持修改操作。
403InvalidOperation.InvalidEniType%s当前弹性网卡的类型不支持此操作。
403InvalidOperation.VpcMismatch%s您的操作无效,请确认该操作中的 VPC 与其它参数是否匹配。
403InvalidOperation.EniServiceManaged%s操作无效。
403InvalidParam.Malformed%s-
403InvalidParam.EniIdAndInstanceId.Conflict%sInstanceId 与 NetworkInterfaceId 两者冲突。两个参数不能同时被赋值。
403Forbidden.InstanceIsBeingCreatedThe specified instance is being created.指定的实例正在创建中。
404InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.指定的安全组在该用户账号下不存在,请您检查安全组 ID 是否正确。
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。
404InvalidEniId.NotFound%s指定的弹性网卡 ID 不存在。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈