查看BMS安全组

最近更新时间: 2026-11-07 00:16:28

1. 接口描述

接口请求域名: bms.api3.fincloud.tencent.cn。

查看BMS安全组

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

接口更新时间:2025-11-27 17:09:58。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DescribeSecurityGroups
Version 是 否 String 公共参数,本接口取值:2018-08-13
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
SecurityGroupIds 否 否 Array of String 安全组实例ID,例如:sg-33ocnj9n,可通过DescribeSecurityGroups获取。每次请求的实例的上限为100。参数不支持同时指定SecurityGroupIds和Filters。
示例值: sg-12sd4fer
Filters 否 否 Array of Filter 过滤条件,参数不支持同时指定SecurityGroupIds和Filters,SecurityGroupDesc和SecurityGroupName模糊查询不支持指定多个。过滤条件:SecurityGroupDesc - String - 安全组描述。SecurityGroupName- String - 安全组名称。
示例值:查看
Offset 否 否 Uint64 偏移量,默认为0。
示例值: 0
Limit 否 否 Uint64 返回数量,默认为20,最大值为100。
示例值: 100

3. 输出参数

参数名称 类型 描述
SecurityGroupSet Array of SecurityGroup 安全组对象
示例值:查看
TotalCount Uint64 符合条件的实例数量。
示例值: 10
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误

5. 示例

示例1 查看BMS安全组

输入示例

{
  "SecurityGroupIds": [
    "sg-fcc867e7"
  ]
}

输出示例

{
  "Response": {
    "SecurityGroupSet": [
      {
        "SecurityGroupId": "sg-fcc867e7",
        "SecurityGroupName": "bms-sec",
        "SecurityGroupDesc": "security group for bms",
        "CurrentNum": 0,
        "CreatedTime": "2026-01-07T15:16:56+08:00"
      }
    ],
    "TotalCount": 1,
    "RequestId": "868e1daf-43fa-74bf-297d-63d58d53081d"
  }
}