Tenant Cloud Network Virtual Private Cloud Security Group APIs DescribeDBInstancesWithSecurityGroup

DescribeDBInstancesWithSecurityGroup

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

1. Interface Description

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

This API (DescribeDBInstancesWithSecurityGroup) is used for security groups to obtain the bound database instance information.

Default interface request rate limit: 20 times per second.

Interface update time: 2021-10-30 22:48:28.

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: DescribeDBInstancesWithSecurityGroup
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.
Example: sg-3mf2tgyv
Filters Yes No Array of Filter Filter criteria.
  • module - String - (Filter criteria) Database type.
  • instance-id- String - (Filter criteria) Instance ID.
  • instance-ip- String - (Filter criteria) Instance IP.

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

    3. Output Parameters

    Parameter name Type Description
    TotalCount Int64 Number of eligible objects.
    Example:
    DBInstances Array of DBInstances Database instance details.
    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

    There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.