Querying Security Group Rules
Function
This API is used to query security group rules.
Debugging
You can debug this API through automatic authentication in API Explorer.
URI
GET /v3/{project_id}/vpc/security-group-rules
Parameter |
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 |
|
security_group_id |
No |
Array of strings |
|
protocol |
No |
Array of strings |
|
description |
No |
Array of strings |
|
remote_group_id |
No |
Array of strings |
|
direction |
No |
String |
|
action |
No |
String |
|
remote_ip_prefix |
No |
String |
|
Request Parameters
None
Response Parameters
Status code: 200
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 Requests
Query security group rules.
GET https://{Endpoint}/v3/{project_id}/vpc/security-group-rules
Example Responses
Status code: 200
Normal response to the GET operation. For more status codes, see Status Codes.
-
{ "request_id" : "80747d36e3376c0894ba8f9a9156355d", "security_group_rules" : [ { "id" : "f626eb24-d8bd-4d26-ae0b-c16bb65730cb", "project_id" : "060576782980d5762f9ec014dd2f1148", "security_group_id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", "direction" : "ingress", "protocol" : "tcp", "description" : "security group rule description", "created_at" : "2020-08-13T07:12:36.000+00:00", "updated_at" : "2020-08-13T07:12:36.000+00:00", "ethertype" : "IPv4", "remote_ip_prefix" : "10.10.0.0/16", "multiport" : 333, "action" : "allow", "priority" : 1, "remote_group_id" : null, "remote_address_group_id" : null } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response to the GET operation. For more status codes, see Status Codes. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot