查询实例安全组信息

最近更新时间:2024-03-12 01:13:38

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBSecurityGroups。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,格式如:cdb-c1nl9rpv或者cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同。
示例值:cdb-eb2w7dto
ForReadonlyInstance Boolean 该值默认为False,表示当传入只读实例ID时,查询操作的是对应只读组的安全组。如果需要操作只读实例ID的安全组, 需要将该入参置为True。
示例值:False
OpResourceId String 变更集群版实例只读组时,InstanceId传实例id,需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。
示例值:cdb-xxx|readonly

3. 输出参数

参数名称 类型 描述
Groups Array of SecurityGroup 安全组详情。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例安全组信息

输入示例

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

{
    "InstanceId": "cdb-eb2w7dto"
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "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. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
CdbError 后端错误或者流程错误。
InternalError.CdbError 系统错误。
InternalError.DBOperationError 数据库操作失败。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.DfwError 安全组操作错误。
InternalError.InternalHttpServerError 请求执行异常。
InternalError.InternalServiceErrorErr 访问内部服务错误。
InternalError.ResourceNotUnique 资源不唯一。
InternalError.SecurityGroupError 安全组错误。
InternalError.UndefinedError 未知错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.ControllerNotFoundError 未找到该接口。
OperationDenied 操作被拒绝。
UnsupportedOperation 操作不支持。