DescribeSecurityGroupPolicies

Last Updated At: 2026-08-02 00:06:20

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeSecurityGroupPolicies) is used to query security group policies.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-11-22 18:58:38.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeSecurityGroupPolicies
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
SecurityGroupId Yes No String Security group instance ID, e.g., sg-33ocnj9n, which can be obtained through DescribeSecurityGroups.
Example: sg-ohuuioma
Filters No No Array of Filter Filter criteria.
security-group-id - String - The security group ID in the rule.
ip - String - IP, supports fuzzy matching for IPv4 and IPv6.
address-module - String - IP address template or IP address group template ID.
service-module - String - Protocol port template or protocol port group template ID.
protocol-type - String - Protocols supported by the security group policy, options: TCP, UDP, ICMP, ICMPV6, GRE, ALL.
port - String - Required or Not: No - Protocol port, supports fuzzy matching, ALL for querying all ports.
poly - String - Protocol policy, options: ALL for all policies; ACCEPT for allow; DROP for deny.
direction - String - Protocol rule, options: ALL for all policies; INBOUND for inbound rules; OUTBOUND for outbound rules.
description - String - Protocol description, supports fuzzy matching.
Example:View

3. Output Parameters

Parameter name Type Description
SecurityGroupPolicySet SecurityGroupPolicySet Security group policy collection.
Example:View
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InvalidParameterValue.Malformed Invalid input format.
ResourceNotFound The resource does not exist