获取指定安全组的详细信息。
使用 GET 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
|---|---|---|---|---|---|
| Action | Query | String | 是 | 公共参数，OpenAPI 接口名称 | DetailSecurityGroup |
| Version | Query | String | 是 | 公共参数，OpenAPI 接口版本 | 2020-10-25 |
| product_id | Query | String | 是 | 筛选条件，业务 ID | 可在「云手机控制台-业务管理-业务详情」中获取 |
| security_group_id | Query | Integer | 是 | 筛选条件，安全组 ID | 可在「云手机控制台-业务管理-安全组」中获取 |
is_show_bound_ins_num | Query | Boolean | 否 | 筛选条件，是否返回安全组绑定的实例数量 |
|
通用返回参数，请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数：
字段 | 类型 | 说明 |
|---|---|---|
| product_id | String | 安全组所属业务 ID |
| security_group_id | Integer | 安全组 ID |
| security_group_name | String | 安全组名称 |
| security_group_desc | String | 安全组描述 |
security_rule_list | Array of objects | 安全组规则列表，参考以下 |
| bind_instance_num | Integer | 安全组绑定的实例数量（is_show_bound_ins_num 设置为 true 时会返回该字段） |
| create_at | Integer | 创建时间，秒级时间戳 |
| update_at | Integer | 更新时间，秒级时间戳 |
List<SecurityRule> 结构说明
字段 | 类型 | 说明 |
|---|---|---|
| rule_id | Integer | 安全组规则 ID |
protocol | Integer | 协议类型：
|
| source_port | Integer | 源端口 |
expose | Integer | 访问规则（仅白名单用户可见）：
|
GET https://open.volcengineapi.com?Action=DetailSecurityGroup
&Version=2020-10-25
&product_id=1471432326763xxxxxx
&security_group_id=1354
&<通过header传入的公共请求参数>
{
"ResponseMetadata": {
"Action": "DetailSecurityGroup",
"Region": "cn-north-1",
"RequestId": "202112281202040102040490790B0072A9",
"Service": "iPaaS",
"Version": "2020-10-25"
},
"Result": {
"product_id": "1471432326763xxxxxx",
"security_group_id": 1354,
"security_group_name": "Security_Group_1",
"security_group_desc": "安全组描述",
"security_rule_list": [
{
"rule_id": 1609,
"protocol": 2,
"source_port": 99,
"expose": 3
}
],
"bind_instance_num": 3,
"create_at": 1640144887,
"update_at": 1640144887
}
}