查询实例安全组

最近更新时间:2024-06-07 02:17:32

我的收藏

1. 接口描述

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

本接口(DescribeDBInstanceSecurityGroups)用于查询实例安全组。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceSecurityGroups。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DBInstanceId String 实例ID,DBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
示例值:postgres-apzvwncr
ReadOnlyGroupId String 只读组ID,DBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
示例值:pgrogrp-nqwpkjbu

3. 输出参数

参数名称 类型 描述
SecurityGroupSet Array of SecurityGroup 安全组信息数组
示例值:[ { "CreateTime": "2022-10-20 21:38:20", "Inbound": [ { "Action": "ACCEPT", "CidrIp": "0.0.0.0/0", "Description": "放通Ping服务", "IpProtocol": "icmp", "PortRange": "ALL" }, { "Action": "ACCEPT", "CidrIp": "::/0", "Description": "放通Ping服务", "IpProtocol": "icmpv6", "PortRange": "ALL" } ], "Outbound": [ { "Action": "ACCEPT", "CidrIp": "0.0.0.0/0", "Description": "", "IpProtocol": "ALL", "PortRange": "ALL" }, { "Action": "ACCEPT", "CidrIp": "", "Description": "", "IpProtocol": "ALL", "PortRange": "ALL" } ], "ProjectId": 0, "SecurityGroupDescription": "自定义模板", "SecurityGroupId": "sg-91jbmkp1", "SecurityGroupName": "自定义模板-20221020213819279" } ]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例安全组

查询实例安全组

输入示例

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

{
    "DBInstanceId": "postgres-i2q4utnp"
}

输出示例

{
    "Response": {
        "RequestId": "770234c2-8a51-4d06-b3f7-4454664848b1",
        "SecurityGroupSet": [
            {
                "CreateTime": "2022-10-20 21:38:20",
                "Inbound": [
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Ping服务",
                        "IpProtocol": "icmp",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Ping服务",
                        "IpProtocol": "icmpv6",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Linux SSH登录",
                        "IpProtocol": "tcp",
                        "PortRange": "22"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Linux SSH登录",
                        "IpProtocol": "tcp",
                        "PortRange": "22"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Windows远程登录",
                        "IpProtocol": "tcp",
                        "PortRange": "3389"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Windows远程登录",
                        "IpProtocol": "tcp",
                        "PortRange": "3389"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "10.0.0.0/8",
                        "Description": "放通内网(云私有网络)",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "172.16.0.0/12",
                        "Description": "放通内网(云私有网络)",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "192.168.0.0/16",
                        "Description": "放通内网(云私有网络)",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "80"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "80"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "443"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "443"
                    }
                ],
                "Outbound": [
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "",
                        "Description": "",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    }
                ],
                "ProjectId": 0,
                "SecurityGroupDescription": "自定义模板",
                "SecurityGroupId": "sg-91jbmkp1",
                "SecurityGroupName": "自定义模板-20221020213819279"
            }
        ]
    }
}

示例2 查询只读组安全组

查询只读组安全组

输入示例

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

{
    "ReadOnlyGroupId": "pgrogrp-nqwpkjb"
}

输出示例

{
    "Response": {
        "RequestId": "47e3764e-bce4-477a-a293-49ffa1bfb447",
        "SecurityGroupSet": [
            {
                "CreateTime": "2022-08-30 21:36:58",
                "Inbound": [],
                "Outbound": [],
                "ProjectId": 0,
                "SecurityGroupDescription": "自定义222",
                "SecurityGroupId": "sg-116auwb1",
                "SecurityGroupName": "自定义222-202208302136517989"
            },
            {
                "CreateTime": "2022-10-20 21:38:20",
                "Inbound": [
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Ping服务",
                        "IpProtocol": "icmp",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Ping服务",
                        "IpProtocol": "icmpv6",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Linux SSH登录",
                        "IpProtocol": "tcp",
                        "PortRange": "22"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Linux SSH登录",
                        "IpProtocol": "tcp",
                        "PortRange": "22"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Windows远程登录",
                        "IpProtocol": "tcp",
                        "PortRange": "3389"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Windows远程登录",
                        "IpProtocol": "tcp",
                        "PortRange": "3389"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "10.0.0.0/8",
                        "Description": "放通内网(云私有网络)",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "172.16.0.0/12",
                        "Description": "放通内网(云私有网络)",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "192.168.0.0/16",
                        "Description": "放通内网(云私有网络)",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "80"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "80"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "443"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "::/0",
                        "Description": "放通Web服务端口",
                        "IpProtocol": "tcp",
                        "PortRange": "443"
                    }
                ],
                "Outbound": [
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "",
                        "Description": "",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    }
                ],
                "ProjectId": 0,
                "SecurityGroupDescription": "自定义模板",
                "SecurityGroupId": "sg-91jbmkp1",
                "SecurityGroupName": "自定义模板-20221020213819279"
            },
            {
                "CreateTime": "2022-08-22 17:34:08",
                "Inbound": [
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "一键放通入站规则",
                        "IpProtocol": "tcp",
                        "PortRange": "22,3389,80,443,20,21"
                    },
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "一键放通入站规则",
                        "IpProtocol": "icmp",
                        "PortRange": "ALL"
                    }
                ],
                "Outbound": [
                    {
                        "Action": "ACCEPT",
                        "CidrIp": "0.0.0.0/0",
                        "Description": "一键放通出站规则",
                        "IpProtocol": "ALL",
                        "PortRange": "ALL"
                    }
                ],
                "ProjectId": 0,
                "SecurityGroupDescription": "拒绝所有",
                "SecurityGroupId": "sg-mpkb1net",
                "SecurityGroupName": "自定义-2022082217335427078"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.FailedOperationError 操作失败,请稍后重试。
FailedOperation.ROGroupNotFoundError 只读组不存在。
InvalidParameter.ParameterCheckError 参数检查失败。
OperationDenied.CamDeniedError 当前操作被限制。
OperationDenied.InstanceAccessDeniedError 您没有权限操作当前资源。
OperationDenied.InstanceStatusLimitOpError 实例状态限制当前操作。
OperationDenied.ROGroupStatusError 只读组状态限制当前操作。
ResourceNotFound.InstanceNotFoundError 实例不存在。