创建安全组

最近更新时间:2018-09-10 21:47:54

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

1. 接口描述

本接口(CreateSecurityGroup)用于创建新的安全组。
接口请求域名:dfw.api.qcloud.com
1)每个账户下每个地域的每个项目的安全组数量限制
2)安全组的唯一ID由系统自动生成;安全组名(输入的sgName字段)由您指定,最多25个UTF-8字符;安全组备注(输入的sgRemark字段)也由您指定,最多100个UTF-8字符,允许重复;如果您有多个项目,可以在创建安全组时选择项目ID(输入的projectId字段),不选择时即在您的默认项目中创建。
新建的安全组的入站和出站规则默认都是全部拒绝,在创建后通常您需要再调用ModifySecurityGroupPolicys将安全组的规则设置为需要的规则。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为CreateSecurityGroup。

参数名称 必选 类型 描述
sgName String 安全组名称,同项目下不可重名,可任意命名,但不得超过60个字符
sgRemark String 安全组备注,最多100个字符
projectId Int 项目id,默认0。可在用户中心->项目管理页面查询到

3. 输出参数

参数名称 类型 描述
code Int 错误码, 0: 成功, 其他值: 失败
message String 错误信息
data Object 返回的数据结构
参数名称 类型 描述
data.sgId String 安全组Id
data.sgName String 安全组名称
data.sgRemark String 安全组备注

4. 错误码表

错误码数值 原因
7000 安全组后台异常
7002 安全组个数已达上限
7005 安全组名已存在
9003 安全组名称/备注超长或包含非法字符

5. 示例

输入


  https://dfw.api.qcloud.com/v2/index.php?Action=CreateSecurityGroup
  &projectId=1000379
  &sgName=组1
  &<公共请求参数>

输出


{
    "code": 0,
    "message": "",
    "data": {
        "sgId": "sg-c3y9ak17",
        "sgName": "组1",
        "sgRemark": ""
    }
}