获取安全组详情

最近更新时间: 2026-09-17 00:07:24

1. 接口描述

接口请求域名: cloudhsm.api3.fincloud.tencent.cn。

获取安全组详情

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

接口更新时间:2020-01-16 11:02:31。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeUsgRule
Version String 公共参数,本接口取值:2019-11-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
SgIds Array of String 根据安全组Id获取安全组详情
示例值: ["sg-6tjv5yxb"]

3. 输出参数

参数名称 类型 描述
SgRules Array of UsgRuleDetail 安全组详情
示例值:查看
TotalCount Int64 安全组详情数量
示例值: 1
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。
ResourceNotFound 资源不存在。

5. 示例

示例1 获取安全组详情

输入示例

https://kms.api3.fincloud.tencent.cn/?Action=DescribeUsgRule
&SgIds.0=xxxxxxxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "SgRules": [{
            "Version": 0,
            "UsgId": "UsgIdxxxxx",
            "UsgName": "UsgNamexxxxxx",
            "InBound": {
                "Ip": "xxxxx",
                "Id": "xxxxxxx",
                "AddressModule": "xxxxxx",
                "Proto": "tcp",
                "Port": "80",
                "ServiceModule": "xxxxxx",
                "Desc": "xxxxxx",
                "Action": "DROP"
            }
        }],
        "RequestId": "6010cd3d-a85a-4e00-b37b-22606d017420"
    }
}