查询安全组列表
更新时间：2021-12-24
接口描述
该接口用于查询用户的所有安全组信息列表。
请求结构
GET /v1/securityGroup?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页号，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 每页安全组个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询的关键字类型，取值为sgName、sgId、instanceId 分别表示安全组名称、安全组ID、实例ID |
| keyword | String | 否 | Query参数 | 查询的关键字值 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序顺序，缺省为createTime |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
| result | List<SecurityGroup> | 安全组信息，由SecurityGroup组成的集合 |
请求示例
GET /v1/securityGroup?pageNo=1&pageSize=10&orderBy=createTime HTTP/1.1
Host: bec.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2021-08-11T04:17:29Z/3600/host/uuid返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2021 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"result": [
{
"id": "sg-m1pxebfd",
"name": "test",
"desc": "",
"rules": [
{
"securityGroupRuleId": "sgr-m1pxebfd-a5cbuah8",
"direction": "egress",
"protocol": "all",
"portRange": "1-65535",
"remark": "全部协议",
"etherType": "IPv4",
"destIp": "0.0.0.0/0"
},
{
"securityGroupRuleId": "sgr-m1pxebfd-xl7y8zt8",
"direction": "ingress",
"protocol": "tcp",
"portRange": "53",
"remark": "DNS服务",
"etherType": "IPv4",
"sourceIp": "0.0.0.0/0"
},
{
"securityGroupRuleId": "sgr-m1pxebfd-vtlzdbkd",
"direction": "egress",
"protocol": "icmp",
"remark": "PING请求_IPv4",
"etherType": "IPv4",
"destIp": "0.0.0.0/0"
}
],
"createdTime": "2021-10-15T06:28:38Z"
},
{
"id": "sg-8vuk2xqw",
"name": "test",
"rules": [
{
"securityGroupRuleId": "sgr-8vuk2xqw-vve4ue6m",
"direction": "egress",
"protocol": "all",
"portRange": "1-65535",
"remark": "全部协议",
"etherType": "IPv4",
"destIp": "0.0.0.0/0"
}
],
"createdTime": "2021-10-15T06:28:38Z"
}
],
"orderBy": "createTime",
"order": "desc",
"pageNo": 1,
"pageSize": 100,
"totalCount": 2
}Model对象定义
SecurityGroup
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 安全组ID |
| name | String | 安全组名称 |
| desc | String | 安全组描述 |
| createdTime | String | 安全组创建时间 |
| rules | List<SecurityGroupRule> | 安全组规则 |
SecurityGroupRule
| 参数名称 | 类型 | 描述 |
|---|---|---|
| direction | String | 入站/出站，取值ingress或egress。 |
| ethertype | String | 网络类型，取值IPv4。暂不支持IPv6 |
| portRange | String | 端口范围，单个端口，或者为1-65535格式的端口范围 |
| protocol | String | 协议类型，tcp、udp或icmp，值为空时默认为所有协议 |
| sourceIp | String | 源IP地址。当direction为ingress时适用 |
| destIp | String | 目的IP地址。当direction为egress时适用 |
| remark | String | 备注 |