修改云主机关联的安全组

最近更新时间:2019-05-31 10:11:13

我的收藏
说明:
当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口(ModifySecurityGroupsOfInstance)用于修改指定云服务器关联的安全组。(本接口将在合适时间下线,建议使用 CVM::ModifyInstancesAttribute 接口来替代本接口的功能)
接口请求域名:dfw.api.qcloud.com
1. 此接口的操作以云服务器为索引,每个云服务器需要独立设置要关联到的安全组 ID 列表。
2. 欠费的云服务器,或正在进行迁移、变更等流程中的云服务器不允许进行关联安全组操作,直到状态恢复正常。
3. 对于绑定了多网卡云服务器,此接口修改云服务器的主网卡所关联的安全组,其他弹性网卡绑定的安全组保持不变。如果需要修改弹性网卡的安全组,请使用ModifySecurityGroupsOfNetworkInterface。
4. 此接口调用后,新的安全组关联关系将覆盖云服务器之前的关联关联关系。假如您的云服务器现在关联了安全组 A 和 B,希望再关联安全组 C,但保留原来的 A 和 B,则输入的 sgIds 参数需要包含 A、B 和 C。移出某个安全组时,输入的 sgIds 参数需要包含剩余的安全组 ID 列表。
5. 与安全组内规则类似,同一个云服务器关联的多个安全组有顺序,按照此接口中输入的 sgIds 顺序生效。当您的安全组规则内包含 action = drop 时,不同的顺序有可能带来不同的网络防护效果,需要谨慎修改。

2. 输入参数

参数名称
必选
类型
描述
instanceSet
Array
云服务器关联安全组数据列表,不超过20个成员
云服务器关联安全组数据字段
参数名称
必选
类型
描述
instanceId
String
云服务器实例 ID,将所传全部云服务器和所传安全组按顺序关联
sgIds
Array
关联安全组唯一 ID 列表,关联顺序依 sgIds 成员顺序

3. 输出参数

参数名称
类型
描述
code
Int
错误码, 0: 成功, 其他值: 失败
message
String
错误信息

4. 错误码表

错误码数值
原因
7000
安全组后台异常
7003
云服务器当前状态禁止关联

5. 示例

输入
https://dfw.api.qcloud.com/v2/index.php?Action=ModifySecurityGroupsOfInstance
&instanceSet.0.instanceId=ins-4q118hl2
&instanceSet.0.sgIds.0=sg-1sdj39df
&instanceSet.0.sgIds.1=sg-o8sk37is
输出
{
"code": 0,
"message": ""
}