获取安全组列表 ListSecurityGroup--云手机-火山引擎

文档中心

立即注册

导航

获取安全组列表 ListSecurityGroup

最近更新时间：2024.05.09 17:19:39首次发布时间：2021.10.18 18:27:22

获取指定业务内已创建的安全组。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListSecurityGroup
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25
product_id	Query	String	是	筛选条件，云机所属的业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
security_group_name	Query	String	否	筛选条件，安全组名称	可在「云手机控制台-业务管理-安全组」中获取
security_group_id	Query	String	否	筛选条件，安全组 ID
detail	Query	Boolean	否	筛选条件，是否返回安全组规则信息	true：返回 false：不返回
offset	Query	Int64	否	分页偏移量	例：0
count	Query	Int64	否	单页数量	例：10

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
total	Int64	返回的安全组数量
row	Array of objects	查询到的安全组信息列表，参考以下 `List<SecurityGroup>` 结构说明

List<SecurityGroup> 结构说明

字段	类型	说明
product_id	String	安全组所属业务 ID
security_group_id	Integer	安全组 ID
security_group_name	String	安全组名称
security_rule_list	Array of objects	安全组规则列表，参考以下 `List<SecurityRule>` 结构说明
bind_instance_num	Integer	安全组绑定的实例数量
create_at	Integer	创建时间，秒级时间戳
update_at	Integer	更新时间，秒级时间戳

List<SecurityRule> 结构说明

字段	类型	说明
rule_id	Integer	安全组规则 ID
protocol	Integer	协议类型： 1 => UDP 2 => TCP 3 => ALL（源端口号同时支持 TCP 和 UDP 协议）
source_port	Integer	源端口

字段

类型

说明

rule_id

Integer

安全组规则 ID

protocol

Integer

协议类型：

1 => UDP
2 => TCP
3 => ALL（源端口号同时支持 TCP 和 UDP 协议）

source_port

Integer

源端口

示例

请求示例

GET https://open.volcengineapi.com?Action=ListSecurityGroup
&Version=2020-10-25
&product_id=1471432326763xxxxxx
&detail=true
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListSecurityGroup",
        "Region": "cn-north-1",
        "RequestId": "2022062815172301017423503803E66CCE",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "row": [
            {
                "product_id": "1467739678185xxxxxx",
                "security_group_id": 1377,
                "security_group_name": "wewef",
                "create_at": 1648532424,
                "update_at": 1648632424,
                "security_rule_list": [
                    {
                        "rule_id": 1918,
                        "protocol": 2,
                        "source_port": 2422
                    }
                ],
                "bind_instance_num": 3
            }
        ],
        "total": 1
    }
}