管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>云加密机>其他接口>获取用户安全组列表

获取用户安全组列表

最近更新时间：2025-05-28 01:12:10

我的收藏

本页目录：

1. 接口描述

接口请求域名： cloudhsm.tencentcloudapi.com 。

根据用户的AppId获取用户安全组列表

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeUsg。
Version 是 String 公共参数，本接口取值：2019-11-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 是 Integer 偏移量，当Offset和Limit均为0时将一次性返回用户所有的安全组列表。
示例值：0
Limit 是 Integer 返回量，当Offset和Limit均为0时将一次性返回用户所有的安全组列表。
示例值：10
SearchWord 否 String 过滤条件，支持安全组id
示例值：sg-p9k0swj3

3. 输出参数

参数名称 类型 描述
SgList Array of SgUnit 用户的安全组列表
示例值：[{"CreateTime":"2024-08-30 10:16:07","SgId":"sg-p9k0swj3","SgName":"放通22，80，443，3389端口和ICMP协议-2024083010155758656","SgRemark":"公网放通云主机常用登录及web服务端口，内网全放通。"}]
TotalCount Integer 返回的安全组数量
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取用户安全组列表

获取用户安全组列表

输入示例

POST / HTTP/1.1
Host: cloudhsm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsg
<公共请求参数>

{
    "Offset": 0,
    "Limit": 10,
    "SearchWord": "sg-p9k0swj3\t"
}

输出示例

{
    "Response": {
        "RequestId": "251e4fb4-110a-4d3e-ac6c-cceff9672394",
        "SgList": [
            {
                "CreateTime": "2024-08-30 10:16:07",
                "SgId": "sg-p9k0swj3",
                "SgName": "放通22，80，443，3389端口和ICMP协议-2024083010155758656",
                "SgRemark": "公网放通云主机常用登录及web服务端口，内网全放通。"
            },
            {
                "CreateTime": "2024-02-02 16:53:18",
                "SgId": "sg-6tjv5yxb",
                "SgName": "default",
                "SgRemark": "System created security group"
            },
            {
                "CreateTime": "2022-09-18 11:24:11",
                "SgId": "sg-ro3eh7bb",
                "SgName": "放通22，80，443，3389端口和ICMP协议-2022091811240925063",
                "SgRemark": "公网放通云主机常用登录及web服务端口，内网全放通。"
            },
            {
                "CreateTime": "2022-02-10 14:24:04",
                "SgId": "sg-3qcokmyz",
                "SgName": "放通全部端口-2022021014240020071",
                "SgRemark": "暴露全部端口到公网和内网，有一定安全风险"
            }
        ],
        "TotalCount": 4
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
中国站
目录