Querying Security Group Rules
Function
This API is used to query security group rules.
URI
GET /v3/{project_id}/vpc/security-group-rules
Name |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
|
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
id |
No |
Array of strings |
ID of the security group rule. Multiple IDs can be specified for filtering. |
security_group_id |
No |
Array of strings |
ID of the security group to which the security group rule belongs. Multiple IDs can be specified for filtering. |
protocol |
No |
Array of strings |
Protocol specified in the security group rule. Multiple protocols can be specified for filtering. |
description |
No |
Array of strings |
Supplementary information about the security group. This field can be used to precisely filter security groups. Multiple descriptions can be specified for filtering. |
remote_group_id |
No |
Array of strings |
ID of the remote security group. Multiple IDs can be specified for filtering. |
direction |
No |
String |
|
action |
No |
String |
Action of the security group rule. |
remote_ip_prefix |
No |
String |
|
Request Parameter
None
Example Request
- Query security group rules.
GET https://{Endpoint}/v3/{project_id}/vpc/security-group-rules
Response Parameter
When the status code is 200, the response parameters are as follows:
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID |
security_group_rules |
Array of SecurityGroupRule objects |
Response body of security group rules |
page_info |
PageInfo object |
Pagination information |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
description |
String |
|
security_group_id |
String |
|
direction |
String |
|
protocol |
String |
|
ethertype |
String |
|
multiport |
String |
|
action |
String |
|
priority |
Integer |
|
remote_group_id |
String |
|
remote_ip_prefix |
String |
|
remote_address_group_id |
String |
|
created_at |
String |
|
updated_at |
String |
|
project_id |
String |
|
Example Response
When the status code is 200, the response parameters are as follows:
{ "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 } ] }
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.