Querying Details About a Security Group (Discarded)
Function
This API is used to query details about a security group.
This API can only query the inbound security group rules. To query the outbound security group rules, see "Querying a Security Group" in "Security Group (Native OpenStack API)" in the Virtual Private Cloud API Reference.
This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Querying a Security Group" in Virtual Private Network API Reference.
URI
GET /v2.1/{project_id}/os-security-groups/{security_group_id}
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. |
security_group_id |
Yes |
Specifies the security group ID, which is specified in the URI. |
Request
None
Response
Table 2 describes the response parameters.
Parameter |
Type |
Description |
---|---|---|
security_group |
Object |
Specifies the security group. For details, see Table 3. |
Parameter |
Type |
Description |
---|---|---|
description |
String |
Specifies information about a security group. It must contain 0 to 255 characters. |
id |
String |
Specifies the security group ID in UUID format. |
name |
String |
Specifies the security group name. It must contain 0 to 255 characters. |
rules |
Array of objects |
Specifies security group rules. For details, see Table 4. |
tenant_id |
String |
Specifies the tenant or project ID. |
Parameter |
Type |
Description |
---|---|---|
parent_group_id |
String |
Specifies the associated security group ID in UUID format. |
ip_protocol |
String |
Specifies the protocol type or the IP protocol number. The value can be icmp, tcp, udp, or the IP protocol number. |
from_port |
Integer |
Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than to_port. When ip_protocol is icmp, this parameter indicates the ICMP type field with a length from 0 to 255 characters.
NOTE:
The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code. |
to_port |
Integer |
Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port. When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
NOTE:
The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code. |
ip_range |
Object |
Specifies the peer IP segment in CIDR format. For details, see Table 5. Specify either ip_range or group. |
group |
Object |
Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see Table 6. Specify either ip_range or group. |
id |
String |
Specifies the security group rule ID. |
Example Request
GET https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/81f1d23b-b1e2-42cd-bdee-359b4a065a42
Example Response
{ "security_group": { "rules": [], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "id": "81f1d23b-b1e2-42cd-bdee-359b4a065a42", "name": "test-sg", "description": "desc-sg" } }
Returned Values
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