查询安全组规则列表
功能介绍
根据用户的查询条件，获取安全组规则的列表信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/security-group-rules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
查询返回边缘安全组规则列表数量。取值范围：0~1000。 最小值：0 最大值：1000 |
|
offset |
否 |
Integer |
查询的偏移量。 |
|
security_group_id |
否 |
String |
安全组ID。uuid |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
security_group_rules |
Array of SecurityGroupRule objects |
安全组规则列表对象。 |
|
count |
Integer |
安全组规则数目。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
安全组规则的ID。 |
|
description |
String |
安全组规则描述信息。 最小长度：0 最大长度：64 |
|
security_group_id |
String |
安全组ID。 |
|
direction |
String |
出入控制方向。 取值范围：
|
|
ethertype |
String |
IP协议类型。 取值范围：IPv4，IPv6 约束：不填默认值为IPv4 |
|
protocol |
String |
协议类型。 取值范围：icmp、tcp、udp、icmpv6等 约束：为空表示支持所有协议 |
|
port_range_min |
String |
起始端口值。 取值范围：1~65535 约束：取值不能大于port_range_max的值，为空表示所有端口 |
|
port_range_max |
String |
结束端口值。 取值范围：1~65535 约束：取值不能小于port_range_min的值，为空表示所有端口。 |
|
remote_group_id |
String |
对端安全组ID。 约束：和remote_ip_prefix互斥 ，remote_group_id与remote_ip_prefix必须存在一个 |
|
remote_ip_prefix |
String |
远端IP地址，当direction是egress时为虚拟机访问端的地址，当direction是ingress时为访问虚拟机的地址。 取值范围：IP地址，或者cidr格式 约束：和remote_group_id互斥 |
|
action |
String |
安全组规则生效策略 取值范围：allow 允许，deny 拒绝 约束：默认值为allow 缺省值：allow |
|
priority |
Integer |
规则在安全组中的优先级 取值范围：1~100，1代表最高优先级 约束：默认值为1 |
请求示例
GET https://{endpoint}/v1/security-group-rules
响应示例
状态码： 200
OK
{
"security_group_rules" : [ {
"description" : "for test",
"direction" : "egress",
"ethertype" : "IPv4",
"id" : "99d9d709-8478-4b46-9f3f-2206b1023fd3",
"protocol" : "TCP",
"port_range_max" : 300,
"port_range_min" : 30,
"remote_group_id" : null,
"remote_ip_prefix" : null,
"security_group_id" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
