1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口（DescribeSecurityGroups）用于查询安全组。
默认接口请求频率限制：100次/秒。
推荐使用 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。每次请求的实例的上限为100。参数不支持同时指定SecurityGroupIds和Filters。 示例值：["sg-33ocnj9n"] |
| Filters.N | 否 | Array of Filter | 过滤条件，参数不支持同时指定SecurityGroupIds和Filters。 示例值：[{"Name": "security-group-id", "Values": ["sg-33ocnj9n"]}] |
| Offset | 否 | String | 偏移量，默认为0。 示例值：0 |
| Limit | 否 | String | 返回数量，默认为20，最大值为100。 示例值：20 |
| OrderField | 否 | String | 排序字段。支持：CreatedTime UpdateTime。注意：该字段没有默认值。示例值：UpdateTime |
| OrderDirection | 否 | String | 排序方法。升序：ASC，倒序：DESC。默认值：ASC示例值：DESC |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecurityGroupSet | Array of SecurityGroup | 安全组对象。 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 符合条件的实例数量。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看安全组
查看安全组
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityGroups
<公共请求参数>
{
"Limit": "1",
"Filters": [
{
"Values": [
"TestGroup"
],
"Name": "security-group-name"
},
{
"Values": [
"0"
],
"Name": "project-id"
}
]
}输出示例
{
"Response": {
"SecurityGroupSet": [
{
"SecurityGroupId": "sg-05bb4upy",
"SecurityGroupName": "TestGroup",
"SecurityGroupDesc": "test-group-desc",
"ProjectId": "0",
"IsDefault": true,
"CreatedTime": "2017-04-18 21:02:30",
"UpdateTime": "",
"TagSet": []
}
],
"TotalCount": 1,
"RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
}
}示例2 查看绑定标签的安全组
用tag:tag-key查询。
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityGroups
<公共请求参数>
{
"Filters": [
{
"Values": [
"TEST"
],
"Name": "tag:Version"
}
]
}输出示例
{
"Response": {
"SecurityGroupSet": [
{
"SecurityGroupId": "sg-2got2lcz",
"SecurityGroupName": "test",
"SecurityGroupDesc": "暴露全部端口到公网和内网，有一定安全风险",
"ProjectId": "0",
"IsDefault": false,
"CreatedTime": "2019-07-23 12:32:24",
"UpdateTime": "",
"TagSet": [
{
"Key": "中文标签键",
"Value": "中文标签值"
},
{
"Key": "Version",
"Value": "TEST"
},
{
"Key": "Version",
"Value": "DEV"
}
]
}
],
"TotalCount": 1,
"RequestId": "85cda7d1-6608-4eca-8d02-19937c12dd84"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.Coexist | 参数不支持同时指定。 |
| InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
| InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
| InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
| InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
