1)接口功能介绍
创建安全组。
2)接口约束
确保安全组端口对应的范围。
3)URI
POST /v1/createSecurityGroup。
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
securityGroupName | 是 | String | 安全组名称。 | xxx-xxx | |
description | 否 | String | 安全组描述 | ttttttttttt | |
ingresses | 否 | List | 入方向规则列表 | * | item |
egresses | 否 | List | 出方向规则列表 | * | item |
表 item
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sourceType | 是 | String | 来源类型,目前只支持IP,取值为:IP,必填。 | IP | |
address | 是 | String | IP地址(段、组),支持IPv4、IPv6的单个地址、地址段和任意地址。单个IP地址:192.168.10.10/32(IPv4地址) ; 2002:50::44/127(IPv6地址)IP地址段:192.168.1.0/24(IPv4地址段) ; 2407:c080:802:469::/64(IPv6地址段)所有IP地址:0.0.0.0/0(IPv4任意地址) ; ::/0(任意地址)。如果乱填,底层会自动修复正确。 | "0.0.0.0/0" | |
protocolType | 是 | String | 协议类型,目前支持ALL(全部)、ICMP、GRE、TCP、UDP 五类。 | UDP | |
ports | 是 | String | 端口号,当协议类型为ALL、ICMP、GRE时,端口为全部端口,取默认值0,可不指定该参数;当协议类型为TCP、UDP时,必须指定1-65535范围内的端口号列表,逗号分隔 | 3389,30000-32000 | |
policyType | 是 | String | 策略,可选类型为ACCEPT-接受、DROP-拒绝两种。 | ACCEPT | |
description | 否 | String | 描述 | test | |
securityGroupId | 否 | String | 安全组Id | 12 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
securityGroupId | 是 | String | 创建的安全组id | 22 |
6)请求示例
请求体body
{
"securityGroupName": "eop-api",
"ingresses": [
{
"sourceType": "IP",
"protocolType": "ALL",
"policyType": "ACCEPT",
"address": "58.23.1.23/32",
"ports": "0",
"description": "test"
}
],
"egresses": [
{
"sourceType": "IP",
"protocolType": "TCP",
"policyType": "DROP",
"address": "188.23.43.2/31",
"ports": "3389",
"description": "test"
}
],
"description": "安全组"
}
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"securityGroupId": "1953"
},
"requestId": "fa25c7c3-8138-4cee-85bd-b4f50abf3e09"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |