云数据库 KeeWiDB 查询实例安全组详情

1. 接口描述

接口请求域名： keewidb.tencentcloudapi.com 。

本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBSecurityGroups。
Version	是	String	公共参数，本接口取值：2022-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
Product	是	String	数据库引擎名称：keewidb。示例值：keewidb
InstanceId	是	String	实例ID，格式如：kee-c1nl9***。示例值：kee-c1nl9rpv

3. 输出参数

参数名称	类型	描述
Groups	Array of SecurityGroup	安全组规则。
VIP	String	安全组生效内网地址。示例值：10.10.0.1
VPort	String	安全组生效内网端口。示例值：6379
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{
    "InstanceId": "kee-9clk****",
    "Product": "keewidb"
}

输出示例

{
    "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-iqxw****",
                "SecurityGroupName": "安全组4",
                "SecurityGroupRemark": "自定义"
            }
        ],
        "RequestId": "6bb17fcf-dd09-440b-806b-198261cff9a1",
        "VIP": "10.0.16.44",
        "VPort": "6379"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.AddInstanceInfoFailed	实例安全组信息添加失败。
FailedOperation.AssociateSecurityGroupsFailed	绑定安全组失败。
FailedOperation.ClearInstanceInfoFailed	实例安全组信息清除失败。
FailedOperation.DisassociateSecurityGroupsFailed	解绑安全组失败。
FailedOperation.DtsStatusAbnormal	当前DTS状态下不允许该操作。
FailedOperation.GetSecurityGroupDetailFailed	获取安全组详情失败。
InternalError.CamAuthOssResponseReturnCodeError	cam鉴权错误。
InternalError.ExecHttpRequestError	执行Http请求失败。
InternalError.ListInstancesError	获取实例列表出错。
InternalError.NetWorkErr	网络错误。
InvalidParameter.IllegalParameterError	非法参数错误。
InvalidParameter.PermissionDenied	接口没有cam权限。
ResourceNotFound.InstanceNotFound	找不到该实例。

查询实例安全组详情

本页目录：