查询安全组规则列表
功能介绍
查询安全组规则列表。
该接口在华北-北京一，华北-北京二，华北-北京四，华北-乌兰察布一，华东-上海一，华东-上海二，华南-广州，华南-深圳，西南-贵阳一，中国-香港，亚太-曼谷，亚太-新加坡，亚太-雅加达，土耳其-伊斯坦布尔，非洲-约翰内斯堡，拉美-墨西哥城一，拉美-墨西哥城二，拉美-圣保罗一，拉美-圣地亚哥区域上线。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/vpc/security-group-rules
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
功能说明：每页返回的个数 取值范围：0-2000 |
marker |
否 |
String |
分页查询起始的资源ID，为空时查询第一页 |
id |
否 |
Array of strings |
功能说明：安全组规则ID，支持多个ID |
security_group_id |
否 |
Array of strings |
功能说明：安全组规则所属安全组ID，支持多个ID过滤 |
protocol |
否 |
Array of strings |
功能说明：安全组规则协议，支持多条过滤 |
description |
否 |
Array of strings |
功能说明：安全组描述新增。可以使用该字段精确过滤安全组，支持传入多个描述进行过滤 |
remote_group_id |
否 |
Array of strings |
功能说明：远端安全组ID，支持多ID过滤 |
direction |
否 |
String |
功能说明：安全组规则方向 |
action |
否 |
String |
功能说明：安全组规则生效策略 |
请求参数
无
请求示例
- 查询安全组规则列表
"GET https://{Endpoint}/v3/{project_id}/vpc/security-group-rules"
响应参数
状态码为 200 时:
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID |
security_group_rules |
Array of SecurityGroupRule objects |
安全组规则列表响应体 |
page_info |
PageInfo object |
分页信息 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
功能描述：安全组规则对应的唯一标识 取值范围：带“-”的标准UUID格式 |
description |
String |
功能说明：安全组的描述信息 取值范围：0-255个字符，不能包含“<”和“>” |
security_group_id |
String |
功能说明：安全组规则所属的安全组ID |
direction |
String |
功能说明：安全组规则的出入控制方向 取值范围：
|
protocol |
String |
功能说明：协议类型 取值范围：icmp、tcp、udp、icmpv6或IP协议号
约束：
|
ethertype |
String |
功能说明：IP地址协议类型 取值范围：IPv4，IPv6 约束：不填默认值为IPv4 |
multiport |
String |
功能说明：端口取值范围 取值范围：支持单端口(80)，连续端口(1-30)以及不连续端口(22,3389,80) |
action |
String |
功能说明：安全组规则生效策略
取值范围：
约束：默认值为deny |
priority |
Integer |
功能说明：优先级 取值范围：1~100，1代表最高优先级 |
remote_group_id |
String |
功能说明：远端安全组ID，表示该安全组内的流量允许或拒绝 取值范围：租户下存在的安全组ID 约束：与remote_ip_prefix，remote_address_group_id功能互斥 |
remote_ip_prefix |
String |
功能说明：远端IP地址，
取值范围：IP地址，或者cidr格式 约束：
|
remote_address_group_id |
String |
功能说明：远端地址组ID 取值范围：租户下存在的地址组ID 约束：与remote_ip_prefix，remote_group_id功能互斥 |
created_at |
String |
功能说明：安全组规则创建时间 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss |
updated_at |
String |
功能说明：安全组规则更新时间 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss |
project_id |
String |
功能说明：安全组规则所属项目ID |
响应示例
状态码为 200 时:
{
"request_id": "80747d36e3376c0894ba8f9a9156355d",
"security_group_rules": [
{
"id": "f626eb24-d8bd-4d26-ae0b-c16bb65730cb",
"project_id": "060576782980d5762f9ec014dd2f1148",
"security_group_id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3",
"remote_group_id": null,
"direction": "ingress",
"protocol": "tcp",
"description": "security group rule description",
"created_at": "2020-08-13T07:12:36Z",
"updated_at": "2020-08-13T07:12:36Z",
"ethertype": "IPv4",
"remote_ip_prefix": "10.10.0.0/16",
"multiport": "333",
"remote_address_group_id": null,
"action": "allow",
"priority": 1
}
]
}
状态码
请参见状态码。
错误码
请参见错误码。
