说明:
当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口(ModifySecurityGroupAttributes)用于修改已经存在的安全组的属性信息,包括名称和描述。
接口请求域名:dfw.api.qcloud.com
1)安全组的名称或描述可以通过系统生成的唯一ID(前缀为sg的字符串)为索引来进行修改。只有当前账号下的安全组允许被修改。
2)修改后的安全组名称不能与同项目中其他安全组相同,不超过25个UTF-8字符;修改后的安全组描述不超过100个UTF-8字符。
3)修改安全组属性信息不影响已绑定的云服务器上的网络安全策略
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为ModifySecurityGroupAttributes。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
sgId | 是 | String | 安全组唯一ID,例如sg-33ocnj9n,可能来自DescribeSecurityGroups或者CreateSecurityGroup |
sgName | 否 | String | 新的安全组名称,可任意命名,但不得超过60个字符 |
sgRemark | 否 | String | 新的安全组备注,不超过100个字符 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码, 0: 成功, 其他值: 失败 |
message | String | 错误信息 |
4. 错误码表
错误码数值 | 原因 |
---|---|
7000 | 安全组后台异常 |
7005 | 安全组名已存在 |
7006 | 系统默认安全组禁止修改 |
9003 | 安全组名称/备注超长或包含非法字符 |
5. 示例
输入
https://dfw.api.qcloud.com/v2/index.php?Action=ModifySecurityGroupAttributes &sgId=sg-o1wkaolh &sgName=测试1 &<公共请求参数>
输出
{
"code": 0,
"message": ""
}