有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProjectSecurityGroups。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
Product String 数据库引擎名称,本接口取值:redis。
示例值:redis
ProjectId Integer 项目 ID。
示例值:11954
Offset Integer 偏移量,取值为Limit的整数倍。
示例值:0
Limit Integer 拉取数量限制,默认 20。
示例值:20
SearchKey String 搜索条件,支持安全组 ID 或者安全组名称。

3. 输出参数

参数名称 类型 描述
Groups Array of SecurityGroup 安全组规则。
Total Integer 符合条件的安全组总数量。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProjectSecurityGroups
<公共请求参数>

{
    "ProjectId": "11954",
    "Product": "redis"
}

输出示例

{
    "Response": {
        "Total": 1,
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A1",
        "Groups": [
            {
                "Outbound": [],
                "SecurityGroupName": "CDB",
                "Inbound": [],
                "ProjectId": 0,
                "SecurityGroupId": "sg-ajr1jzgj",
                "SecurityGroupRemark": "",
                "CreateTime": "2017-04-13 15:00:06"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AddInstanceInfoFailed 实例安全组信息添加失败。
FailedOperation.AssociateSecurityGroupsFailed 绑定安全组失败。
FailedOperation.ClearInstanceInfoFailed 实例安全组信息清除失败。
FailedOperation.DisassociateSecurityGroupsFailed 解绑安全组失败。
FailedOperation.DtsStatusAbnormal 当前DTS状态下不允许该操作。
FailedOperation.FlowNotExists 流表不存在。
InvalidParameter.ActionNotFound 没有找到对应接口。
InvalidParameter.IllegalParameterError 非法参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。