Querying Security Groups
Function
This API is used to query all security groups of a tenant.
Constraints
You can query all security groups under your account. A maximum of 2,000 records can be returned for each query. If the number of records exceeds 2,000, the pagination marker will be returned.
Debugging
You can debug this API through automatic authentication in API Explorer.
URI
GET /v3/{project_id}/vpc/security-groups
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 |
|
name |
No |
Array of strings |
|
description |
No |
Array of strings |
|
enterprise_project_id |
No |
String |
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
security_groups |
Array of SecurityGroup objects |
Response body for querying security groups. |
request_id |
String |
Request ID. |
page_info |
PageInfo object |
Pagination information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
name |
String |
|
description |
String |
|
project_id |
String |
|
created_at |
String |
|
updated_at |
String |
|
enterprise_project_id |
String |
|
tags |
Array of Tag objects |
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
|
value |
String |
|
Example Requests
Querying security groups.
GET https://{Endpoint}/v3/{project_id}/vpc/security-groups
Example Responses
Status code: 200
Normal response to the GET operation. For more status codes, see Status Codes.
-
{ "request_id" : "d31cb32ca06f3c1a294fa24e6cbc5a56", "security_groups" : [ { "id" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", "name" : "sg-test", "project_id" : "060576782980d5762f9ec014dd2f1148", "description" : "test", "enterprise_project_id" : 0, "created_at" : "2019-10-16T11:11:14.000+00:00", "updated_at" : "2020-03-25T10:53:46.000+00:00", "tags" : [ ] }, { "id" : "0b8cb773-197c-4c91-94f1-e051f0563e5a", "name" : "test-sg", "project_id" : "060576782980d5762f9ec014dd2f1148", "description" : "The security group is for general-purpose web servers and includes default rules that allow all inbound ICMP traffic and allow inbound traffic on ports 22, 3389, 80, and 443. This security group is suitable for ECSs that require remote login, public network ping, and website services.", "enterprise_project_id" : 0, "created_at" : "2019-12-03T09:02:11.000+00:00", "updated_at" : "2019-12-03T09:02:11.000+00:00", "tags" : [ ] } ], "page_info" : { "previous_marker" : "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", "current_count" : 2 } }
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