文档中心

数据库工作台

安全管控

DescribeSecurityGroups

调用 DescribeSecurityGroups 接口查询安全规则集。

请求类型

同步请求。

请求参数

名称	类型	是否必选	描述	示例值
PageNumber	Integer	是	页码。取值范围 1~1000，默认值为 1。	10
PageSize	Integer	是	每页记录数。取值范围 1~1000，默认值为 10。	1
SecGroupSearchParam	Object[]	否	安全规则集的筛选条件。	请参见请求示例。

返回参数

名称	类型	描述	示例值
SecurityGroups	JSON	Object[]	请参见返回示例。
Total	String	返回的安全规则集的数量。	7

请求示例

POST /?Action=DescribeSecurityGroups&Version=2018-01-01 HTTP/1.1​
Content-Type: application/json​
Host: dbw.cn-beijing.volcengineapi.com​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "PageSize": 10,​
    "PageNumber": 1,​
    "SecGroupSearchParam": {​
        "InstanceType": "MySQL",​
        "Keyword": "mysql default"​
    }​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2025090317335918DB6C82690D0ACF90E5-de1f85",​
        "Action": "DescribeSecurityGroups",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "SecurityGroups": [​
            {​
                "AssociatedInstanceNum": 10,​
                "Category": "Default",​
                "Comment": "auto created by trigger 2100067216",​
                "ID": "1740264867044012032",​
                "InstanceType": "MySQL",​
                "Name": "mysql default",​
                "UpdateTime": "1703746451"​
            },​
            {​
                "AssociatedInstanceNum": 1,​
                "Category": "Default",​
                "Comment": "auto created by trigger 2100000746",​
                "ID": "1798193780860391424",​
                "InstanceType": "Postgres",​
                "Name": "postgres default",​
                "UpdateTime": "1717557780"​
            },​
             {​
                "AssociatedInstanceNum": 1,​
                "Category": "Default",​
                "Comment": "auto created by trigger 2100067216",​
                "ID": "1805169413175947264",​
                "InstanceType": "VeDBMySQL",​
                "Name": "vedb_mysql default",​
                "UpdateTime": "1719220901"​
            },            ​
            {​
                "AssociatedInstanceNum": 0,​
                "Category": "Custom",​
                "Comment": "created by",​
                "ID": "1826683897031692288",​
                "InstanceType": "MySQL",​
                "Name": "、、、",​
                "UpdateTime": "1724350353"​
            },​
            {​
                "AssociatedInstanceNum": 0,​
                "Category": "Default",​
                "Comment": "auto created by trigger 2100067216",​
                "ID": "1833328583884464128",​
                "InstanceType": "MSSQL",​
                "Name": "SQLSever default",​
                "UpdateTime": "1725934570"​
            },​
            {​
                "AssociatedInstanceNum": 0,​
                "Category": "Custom",​
                "Comment": "created by",​
                "ID": "1843610605055934464",​
                "InstanceType": "Postgres",​
                "Name": "6767",​
                "UpdateTime": "1728385995"​
            },​
            {​
                "AssociatedInstanceNum": 0,​
                "Category": "Custom",​
                "Comment": "created by",​
                "ID": "1851903984349007872",​
                "InstanceType": "MSSQL",​
                "Name": "test",​
                "UpdateTime": "1730363291"​
            }​
        ],​
        "Total": 7​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2025.09.26 14:38:21

这个页面对您有帮助吗？

有用

无用