查询项目安全组信息
最近更新时间: 2024-10-18 10:38:29
1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.cn。
本接口（DescribeProjectSecurityGroups）用于查询项目安全组信息
默认接口请求频率限制：20次/秒。
接口更新时间：2023-02-08 11:58:03。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeProjectSecurityGroups |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Product | 是 | 否 | String | 数据库引擎名称，本接口取值：dcdb。 |
| ProjectId | 是 | 否 | Uint64 | 项目ID，TCE上恒传0。 |
| Offset | 否 | 否 | Uint64 | 偏移量。 |
| Limit | 否 | 否 | Uint64 | 拉取数量限制。 |
| SearchKey | 否 | 否 | String | 搜索条件，支持安全组id或者安全组名称。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Groups | SecurityGroup | 安全组详情。 |
| Total | Uint64 | 符合条件的安全组总数量。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.AddInstanceInfoFailed | |
| FailedOperation.AssociateSecurityGroupsFailed | |
| FailedOperation.ClearInstanceInfoFailed | |
| FailedOperation.DisassociateSecurityGroupsFailed | |
| FailedOperation.SetRuleLocationFailed | |
| FailedOperation.UpdateInstanceInfoFailed | |
| InternalError.GetSecurityGroupDetailFailed | |
| InternalError.QueryDatabaseFailed | |
| InternalError.UpdateDatabaseFailed | |
| InvalidParameter | |
| InvalidParameter.InstanceNotFound | |
| ResourceUnavailable.InstanceStatusAbnormal | |
| UnauthorizedOperation.PermissionDenied | |
| AuthFailure |