获取用户安全组列表

最近更新时间: 2026-09-17 00:07:24

1. 接口描述

接口请求域名： cloudhsm.api3.fincloud.tencent.cn。

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

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

接口更新时间：2020-01-16 11:03:14。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeUsg
Version	是	否	String	公共参数，本接口取值：2019-11-12
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	是	否	Int64	偏移量，当Offset和Limit均为0时将一次性返回用户所有的安全组列表。示例值： 0
Limit	是	否	Int64	返回量，当Offset和Limit均为0时将一次性返回用户所有的安全组列表。示例值： 10
SearchWord	否	否	String	搜索关键字示例值： sg-p9k0swj3

3. 输出参数

参数名称	类型	描述
SgList	Array of SgUnit	用户的安全组列表示例值：查看
TotalCount	Int64	返回的安全组数量示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

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

获取用户安全组列表

输入示例

https://kms.api3.fincloud.tencent.cn/?Action=DescribeUsg
&Offset=0&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount":1,
            "SgList":[{
                    "SgId":"SgIdxxxxx",
                    "SgName":"SgNamexxxxxx"
                 }
            ],
        "RequestId": "6010cd3d-a85a-4e00-b37b-22606d017420"
    }
}