Tenant Cloud Network Virtual Private Cloud Security Group APIs DescribeSecurityGroups

DescribeSecurityGroups

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

1. Interface Description

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

This API (DescribeSecurityGroups) is used to query security groups.

Default interface request rate limit: 100 times per second.

Interface update time: 2020-04-21 23:32:36.

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: DescribeSecurityGroups
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
SecurityGroupIds No No Array of String Security group instance ID, e.g., sg-33ocnj9n, which can be obtained through DescribeSecurityGroups. The maximum number of instances per request is 100. The parameter does not support specifying both SecurityGroupIds and Filters simultaneously.
Example: ["sg-33ocnj9n"]
Filters No No Array of Filter Filter criteria. Parameters SecurityGroupIds and Filters must not be specified simultaneously.
  • security-group-id - String - (Filter criteria) Security group ID.
  • project-id - Integer - (Filter criteria) Project ID.
  • security-group-name - String - (Filter criteria) Security group name.
  • tag-key - String - Required or Not: No - (Filter criteria) Filter by tag key. Refer to example 2 for usage.
  • tag:tag-key - String - Required or Not: No - (Filter criteria) Filter by tag-key value pair. Replace tag-key with the specific tag-key. Refer to example 3 for usage.

    • Example:View
    Offset No No String Offset. 0 by default.
    Example: 0
    Limit No No String Number of returns, 20 by default, up to 100.
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    SecurityGroupSet Array of SecurityGroup Security group object.
    Example:View
    TotalCount Uint64 Number of eligible instances.
    Example:
    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