获取用户安全组列表

最近更新时间:2020-03-16 08:23:26

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cloudhsm.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUsg。
Version String 公共参数,本接口取值:2019-11-12。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 偏移量,当Offset和Limit均为0时将一次性返回用户所有的安全组列表。
Limit Integer 返回量,当Offset和Limit均为0时将一次性返回用户所有的安全组列表。
SearchWord String 搜索关键字

3. 输出参数

参数名称 类型 描述
SgList Array of SgUnit 用户的安全组列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 返回的安全组数量
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

获取用户安全组列表

输入示例

https://kms.tencentcloudapi.com/?Action=DescribeUsg
&Offset=0&Limit=10
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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