1. 接口描述
接口请求域名： keewidb.tencentcloudapi.com 。
本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeProjectSecurityGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2022-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Product | 是 | String | 数据库引擎名称。该产品固定为 keewidb。 示例值：keewidb |
| ProjectId | 否 | Integer | 项目 ID。 登录 账号中心，在项目管理中可获取项目 ID。 示例值：11954 |
| Offset | 否 | Integer | 分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。 示例值：0 |
| Limit | 否 | Integer | 每页安全组的数量限制。默认为 20，最多输出100条。 示例值：20 |
| SearchKey | 否 | String | 搜索关键词，支持根据安全组 ID 或者安全组名称搜索。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Groups | Array of SecurityGroup | 安全组规则。 |
| Total | Integer | 符合条件的安全组总数量。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
输入示例
POST / HTTP/1.1
Host: keewidb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectSecurityGroups
<公共请求参数>
{
"ProjectId": "0",
"Product": "keewidb",
"Limit": "100",
"Offset": "0"
}输出示例
{
"Response": {
"Groups": [
{
"CreateTime": "2021-10-30 16:11:08",
"Inbound": [
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "10.0.0.0/8",
"Desc": "",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "7777",
"ServiceModule": ""
}
],
"Outbound": [],
"ProjectId": 0,
"SecurityGroupId": "sg-iqxwbwkp",
"SecurityGroupName": "安全组4",
"SecurityGroupRemark": "自定义"
},
{
"CreateTime": "2021-10-30 16:10:23",
"Inbound": [
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "10.0.0.0/8",
"Desc": "",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "2456",
"ServiceModule": ""
}
],
"Outbound": [],
"ProjectId": 0,
"SecurityGroupId": "sg-dutt0kpv",
"SecurityGroupName": "安全组3",
"SecurityGroupRemark": "自定义"
},
{
"CreateTime": "2021-10-30 16:09:33",
"Inbound": [
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "10.0.0.0/8",
"Desc": "",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "9091",
"ServiceModule": ""
}
],
"Outbound": [],
"ProjectId": 0,
"SecurityGroupId": "sg-eudoq1bd",
"SecurityGroupName": "安全组2",
"SecurityGroupRemark": "自定义"
},
{
"CreateTime": "2021-10-30 16:08:29",
"Inbound": [
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "放通Web服务HTTP（80），如 Apache、Nginx",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "80",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "支持Ping服务",
"Id": "",
"IpProtocol": "icmp",
"PortRange": "ALL",
"ServiceModule": ""
}
],
"Outbound": [],
"ProjectId": 0,
"SecurityGroupId": "sg-fsot7c33",
"SecurityGroupName": "安全组1",
"SecurityGroupRemark": "自定义"
},
{
"CreateTime": "2021-07-15 11:51:07",
"Inbound": [
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "放通Windows远程登录",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "3389",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "::/0",
"Desc": "放通Windows远程登录",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "3389",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "放通Linux SSH登录",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "22",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "::/0",
"Desc": "放通Linux SSH登录",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "22",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "放通Web服务端口",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "80,443",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "::/0",
"Desc": "放通Web服务端口",
"Id": "",
"IpProtocol": "tcp",
"PortRange": "80,443",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "放通Ping服务",
"Id": "",
"IpProtocol": "icmp",
"PortRange": "ALL",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "::/0",
"Desc": "放通Ping服务",
"Id": "",
"IpProtocol": "icmpv6",
"PortRange": "ALL",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "10.0.0.0/8",
"Desc": "放通内网",
"Id": "",
"IpProtocol": "ALL",
"PortRange": "ALL",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "172.16.0.0/12",
"Desc": "放通内网",
"Id": "",
"IpProtocol": "ALL",
"PortRange": "ALL",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "192.168.0.0/16",
"Desc": "放通内网",
"Id": "",
"IpProtocol": "ALL",
"PortRange": "ALL",
"ServiceModule": ""
}
],
"Outbound": [
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "0.0.0.0/0",
"Desc": "",
"Id": "",
"IpProtocol": "ALL",
"PortRange": "ALL",
"ServiceModule": ""
},
{
"Action": "ACCEPT",
"AddressModule": "",
"CidrIp": "",
"Desc": "",
"Id": "",
"IpProtocol": "ALL",
"PortRange": "ALL",
"ServiceModule": ""
}
],
"ProjectId": 0,
"SecurityGroupId": "sg-fkkzqw25",
"SecurityGroupName": "放通22，80，443，3389端口和ICMP协议-2021071511491886714",
"SecurityGroupRemark": "公网放通云主机常用登录及web服务端口，内网全放通。"
}
],
"RequestId": "f82bd0dc-48c2-4986-8b64-d330688bed80",
"Total": 5
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.AddInstanceInfoFailed | 实例安全组信息添加失败。 |
| FailedOperation.AssociateSecurityGroupsFailed | 绑定安全组失败。 |
| FailedOperation.ClearInstanceInfoFailed | 实例安全组信息清除失败。 |
| FailedOperation.DisassociateSecurityGroupsFailed | 解绑安全组失败。 |
| FailedOperation.DtsStatusAbnormal | 当前DTS状态下不允许该操作。 |
| InvalidParameter.IllegalParameterError | 非法参数错误。 |