API文档

查看安全组

最近更新时间:2020-06-16 08:47:48

1. 接口描述

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

本接口(DescribeSecurityGroups)用于查询安全组。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSecurityGroups。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SecurityGroupIds.N Array of String 安全组实例ID,例如:sg-33ocnj9n,可通过DescribeSecurityGroups获取。每次请求的实例的上限为100。参数不支持同时指定SecurityGroupIds和Filters。
Filters.N Array of Filter 过滤条件,参数不支持同时指定SecurityGroupIds和Filters。
  • security-group-id - String - (过滤条件)安全组ID。
  • project-id - Integer - (过滤条件)项目ID。
  • security-group-name - String - (过滤条件)安全组名称。
  • tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。使用请参考示例2。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例3。
  • Offset String 偏移量,默认为0。
    Limit String 返回数量,默认为20,最大值为100。

    3. 输出参数

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

    4. 示例

    示例1 查看安全组

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeSecurityGroups
    &Limit=1
    &Filters.0.Name=project-id
    &Filters.0.Values.0=0
    &Filters.1.Name=security-group-name
    &Filters.1.Values.0=TestGroup
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "SecurityGroupSet": [
          {
            "SecurityGroupId": "sg-05bb4upy",
            "SecurityGroupName": "TestGroup",
            "SecurityGroupDesc": "test-group-desc",
            "ProjectId": "0",
            "CreateTime": "2017-04-18 21:02:30"
          }
        ],
        "TotalCount": 1,
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
      }
    }

    示例2 查看绑定标签的安全组

    用tag:tag-key查询。

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeSecurityGroups
    &Filters.0.Name=tag:Version
    &Filters.0.Values.0=TEST
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "SecurityGroupSet": [
          {
            "SecurityGroupId": "sg-2got2lcz",
            "SecurityGroupName": "test",
            "SecurityGroupDesc": "暴露全部端口到公网和内网,有一定安全风险",
            "ProjectId": "0",
            "IsDefault": false,
            "CreatedTime": "2019-07-23 12:32:24",
            "TagSet": [
              {
                "Key": "中文标签键",
                "Value": "中文标签值"
              },
              {
                "Key": "Version",
                "Value": "TEST"
              },
              {
                "Key": "Version",
                "Value": "DEV"
              }
            ]
          }
        ],
        "TotalCount": 1,
        "RequestId": "85cda7d1-6608-4eca-8d02-19937c12dd84"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。
    目录