1. 接口描述
接口请求域名： mariadb.tencentcloudapi.com 。
本接口（DescribeDBSecurityGroups）用于查询实例安全组信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDBSecurityGroups。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Product | 是 | String | 数据库引擎名称，本接口取值：mariadb。 示例值：mariadb |
| InstanceId | 是 | String | 实例ID。 示例值：tdsql-eb2w7dto |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Groups | Array of SecurityGroup | 安全组详情。 |
| VIP | String | 实例VIP。 注意：此字段可能返回 null，表示取不到有效值。 |
| VPort | String | 实例端口。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1 查询实例安全组信息
输入示例
https://mariadb.tencentcloudapi.com/?Action=DescribeDBSecurityGroups
&Product=mariadb
&InstanceId=tdsql-eb2w7dto
&<公共请求参数>输出示例
{
"Response": {
"VIP": "10.0.0.7",
"VPort": "3306",
"RequestId": "31a60135-7057-47ae-8fd3-7a0617deca38",
"Groups": [
{
"ProjectId": 0,
"CreateTime": "",
"Inbound": [
{
"Action": "",
"CidrIp": "",
"PortRange": "",
"IpProtocol": ""
}
],
"Outbound": [
{
"Action": "",
"CidrIp": "",
"PortRange": "",
"IpProtocol": ""
}
],
"SecurityGroupId": "",
"SecurityGroupName": "",
"SecurityGroupRemark": "mariadb"
}
]
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.AuthNoStrategy | 鉴权失败。 |
| FailedOperation.GetSecurityGroupDetailFailed | 拉取安全组详情失败。 |
| InternalError.GetSecurityGroupDetailFailed | 拉圈安全组详情失败。 |
| InternalError.InstanceOperatePermissionError | 用户对当前实例无操作权限。 |
| InternalError.ListInstanceRespResourceCountNotMatchError | 查询实例时返回的资源数量与请求不匹配。 |
| InternalError.ListInstancesError | 查询实例错误。 |
| InternalError.QueryDatabaseFailed | 操作读DB数据错误。 |
| InternalError.ReadDatabaseFailed | 操作读DB数据错误。 |
| InternalError.RouteNotFound | 路由未发现。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.IllegalParameterError | 非法参数。 |
| InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
| InvalidParameter.PermissionDenied | 没有权限操作该接口或资源。 |
| InvalidParameterValue.InvalidParameterValueError | 参数验证错误。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceNotFound.ProductConfigNotExistedError | 接入安全组产品配置不存在。 |
| ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确，当前无法操作。 |
| UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |