Querying Security Groups
Function
This API is used to query security groups using search criteria and to display the security groups in a list.
URI
GET /v1/{project_id}/security-groups
Example:
GET https://{Endpoint}/v1/{project_id}/security-groups?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85
Table 1 describes the parameters.
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit.
|
limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker. |
vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. |
Request Parameters
None
Example Request
GET https://{Endpoint}/v1/{project_id}/security-groups
Response Parameters
Parameter | Type | Description |
---|---|---|
security_groups | Array of security_group objects | Specifies the security group objects. For details, see Table 3. |
Parameter | Type | Description |
---|---|---|
name | String | Specifies the security group name. |
description | String | Provides supplementary information about the security group. |
id | String | Specifies the security group ID, which uniquely identifies the security group. |
vpc_id | String | Specifies the ID of the VPC that the security group is associated with. NOTE: Currently, this parameter is not recommended because it is only used as a prompt and does not restrict that the security group must be associated with the VPC. |
security_group_rules | Array of security_group_rule objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. |
Parameter | Type | Description |
---|---|---|
id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
description | String |
|
security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
direction | String |
|
ethertype | String |
|
protocol | String |
|
port_range_min | Integer |
|
port_range_max | Integer |
|
remote_ip_prefix | String |
|
remote_group_id | String |
|
tenant_id | String |
|
Example Response
{"security_groups": [{"id": "16b6e77a-08fa-42c7-aa8b-106c048884e6","name": "qq","description": "qq","vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85","security_group_rules": [{"id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80","tenant_id": "060576782980d5762f9ec014dd2f1148","security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325","remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325","direction": "ingress","protocol": null,"description": "","ethertype": "IPv6","remote_ip_prefix": null,"port_range_max": null,"port_range_min": null},{"id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677","tenant_id": "060576782980d5762f9ec014dd2f1148","security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325","remote_group_id": null,"direction": "egress","protocol": null,"description": "","ethertype": "IPv6","remote_ip_prefix": null,"port_range_max": null,"port_range_min": null},{"id": "9581f18c-1fdd-43da-ace9-7758a56ef28a","tenant_id": "060576782980d5762f9ec014dd2f1148","security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325","remote_group_id": null,"direction": "egress","protocol": null,"description": "","ethertype": "IPv4","remote_ip_prefix": null,"port_range_max": null,"port_range_min": null},{"id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8","tenant_id": "060576782980d5762f9ec014dd2f1148","security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325","remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325","direction": "ingress","protocol": null,"description": "","ethertype": "IPv4","remote_ip_prefix": null,"port_range_max": null,"port_range_min": null}]},{"id": "9c0f56be-a9ac-438c-8c57-fce62de19419","name": "default","description": "qq","vpc_id": "13551d6b-755d-4757-b956-536f674975c0","security_group_rules": [{"direction": "egress","ethertype": "IPv4","id": "95479e0a-e312-4844-b53d-a5e4541b783f","description": "","security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"},{"direction": "ingress","ethertype": "IPv4","id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431","description": "","remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419","security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"}]}]}
Status Code
See Status Codes.
Error Code
See Error Codes.
- Function
- URI
- Request Parameters
- Example Request
- Response Parameters
- Example Response
- Status Code
- Error Code