QuerySecurityGroupRule

GET/zstack/v1/security-groups/rules

GET/zstack/v1/security-groups/rules/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 9aa7adfe564e4acda956ef90430b0f1b" \
-X GET http://localhost:8080/zstack/v1/security-groups/rules?q=endPort=22&q=state=Enabled

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 36a86c5b46784b169fe82d7c990ae1a7" \
-X GET http://localhost:8080/zstack/v1/security-groups/rules/ae59353d95f744b5b4396e1783ddb918

Queryable Fields

Run the CLI tool, type QuerySecurityGroupRule and press the Tab key to view all queryable fields and cross-table queryable resource names.

API Response

Response Example

{
  "inventories": [
    {
      "uuid": "b3a99fc1548b41778258153cfd70f4b7",
      "securityGroupUuid": "629d55f78c9f4b0e8e3504b9834ca1bb",
      "type": "Ingress",
      "startPort": 22.0,
      "endPort": 22.0,
      "protocol": "TCP",
      "state": "Enabled",
      "allowedCidr": "0.0.0.0/0",
      "createDate": "Jun 7, 2017 9:20:25 PM",
      "lastOpDate": "Jun 7, 2017 9:20:25 PM"
    }
  ]
}

Name	Type	Description	Starting Version
error	ErrorCode	Error code. If not null, the operation failed. If null, the operation succeeded. See error	0.6
inventories	List	See inventories	0.6

error

Name	Type	Description	Starting Version
code	String	Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed error information	0.6
elaboration	String	Reserved field, defaults to null	0.6
opaque	LinkedHashMap	Reserved field, defaults to null	0.6
cause	ErrorCode	Root error: the source error that caused the current error. If there is no original error, this field is null	0.6

inventories

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource, uniquely identifying the resource	0.6
securityGroupUuid	String	The security group UUID	0.6
type	String	The traffic type	0.6
ipVersion	Integer	The IP version number	3.1.0
startPort	Integer	For TCP/UDP, it is the start port number of the port range; for ICMP, it is the ICMP type	0.6
endPort	Integer	For TCP/UDP, it is the end port number of the port range; for ICMP, it is the ICMP type	0.6
protocol	String	The traffic protocol type	0.6
state	String	The availability state of the rule, not implemented in the current version	0.6
allowedCidr	String	The allowed CIDR. The meaning of the allowed CIDR varies depending on the traffic type. For Ingress traffic, the allowed CIDR is the source CIDR that is permitted to access the VM NIC. For Egress traffic, the allowed CIDR is the destination CIDR that traffic from the VM NIC is permitted to reach	0.6
remoteSecurityGroupUuid	String		0.6
createDate	Timestamp	The creation time	0.6
lastOpDate	Timestamp	The last modification time	0.6

SDK Examples

Java SDK

QuerySecurityGroupRuleAction action = new QuerySecurityGroupRuleAction();
action.conditions = asList("endPort=22","state=Enabled");
action.sessionId = "362452e4e8a746ce981a5a54c7390445";
QuerySecurityGroupRuleAction.Result res = action.call();

Python SDK

QuerySecurityGroupRuleAction action = QuerySecurityGroupRuleAction()
action.conditions = ["endPort=22","state=Enabled"]
action.sessionId = "37e099aa344c40ca947d11dff7ec2b91"
QuerySecurityGroupRuleAction.Result res = action.call()