创建安全组
更新时间:2024-07-02
该接口用于创建安全组以及安全组规则。
- 同一安全组中的规则以remark、protocol、direction、portRange、sourceIp|destIp、sourceGroupId|destGroupId唯一性索引,重复记录会报409错误。
- protocol的取值(tcp|udp|icmp),默认值为空,代表all。
请求结构
POST /v{version}/securityGroup?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串,详见ClientToken幂等性。 |
name | String | 是 | RequestBody参数 | 创建的安全组的名字,支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65。 |
vpcId | String | 否 | RequestBody参数 | 安全组所属的vpcId。 |
desc | String | 否 | RequestBody参数 | 对所创建的安全组的描述信息 |
rules | List<SecurityGroupRuleModel> | 是 | RequestBody参数 | 创建安全组时绑定的安全组规则列表 |
tags | List<Tag> | 否 | RequestBody参数 | 创建安全组时绑定的标签列表 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
securityGroupId | String | 已创建的安全组的ID |
错误码
错误码 | 错误描述 | HTTP状态码 | 中文解释 |
---|---|---|---|
SecurityGroup.RuleRemarkTooLong | Security group description is too long. | 400 | 安全组规则备注字段超限 |
BadRequest | protocol is invalid. | 400 | 协议类型错误 |
SecurityGroup.RulePortOrderInvalid | The order of security group rule port is incorrect. | 400 | 安全组规则端口顺序不正确 |
SecurityGroup.RulePortRangeInvalid | The value of security group rule port is exceeded. | 400 | 安全组规则的端口数字超出允许范围 |
SecurityGroup.RulePortInvalid | The value of security group rule port must be number. | 400 | 安全组规则端口非数字 |
SecurityGroup.RuleCIDRAddressError | Security group rule ip(cidr) address is incorrect. | 400 | 安全组规则源(目标)地址错误 |
SecurityGroup.RuleDirectionError | Security group rule direction is incorrect. | 400 | 安全组规则direction不符合 |
SecurityGroup.RuleNumberExceededLimit | Security groups that contain rule number exceed limit. | 413 | 安全组所包含规则数目超限 |
SecurityGroup.RuleDuplicated | Security group rule is duplicated. | 409 | 安全组规则重复 |
请求示例
POST /v2/securityGroup?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"name": "test-security-group",
"desc": "create a security group for api doc",
"vpcId": "vpc-uxjret8rnv",
"rules": [
{
"remark": "备注",
"protocol": "tcp",
"portRange": "1-65535",
"direction": "ingress",
"sourceIp": "",
"sourceGroupId": ""
},
{
"remark": "全部协议",
"protocol": "",
"portRange": "",
"direction": "egress",
"destIp": "",
"destGroupId": ""
}
]
}
返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"securityGroupId": "g-nky7qeom"
}