文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器网络隔离信息/ 查询企业项目下所有的安全组列表 - ListSecurityGroups
更新时间:2025-10-31 GMT+08:00
分享

查询企业项目下所有的安全组列表 - ListSecurityGroups

功能介绍

查询企业项目下所有的安全组列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/container-network/security-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of SecurityGroup objects

安全组列表

表5 SecurityGroup

参数

参数类型

描述

security_group_id

String

安全组ID

security_group_name

String

安全组名称

security_group_description

String

安全组描述

请求示例

查询集群下某一命名空间下的安全组列表

GET https://{endpoint}/v5/{project_id}/container-network/security-groups?enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

[ {
  "security_group_id" : "03b46bce-b0b7-42d3-992d-ddfb567106f0",
  "security_group_name" : "sg-4a7d",
  "security_group_description" : "通用Web服务器,默认放通22、3389、80、443端口和ICMP协议。 适用于需要远程登录、公网ping及用于网站服务的云服务器场景。"
}, {
  "security_group_id" : "090cef69-1b90-4f86-9e10-ba593811fcf4",
  "security_group_name" : "sg-df44",
  "security_group_description" : "通用Web服务器,默认放通22、3389、80、443端口和ICMP协议。 适用于需要远程登录、公网ping及用于网站服务的云服务器场景。"
}, {
  "security_group_id" : "110a7b73-7fae-4c28-bae8-535f6a853613",
  "security_group_name" : "hss-test-block",
  "security_group_description" : "默认放通22、3389、80、443端口和ICMP协议。适用于需要远程登录、公网ping及用于网站服务的云服务器场景。"
}, {
  "security_group_id" : "11e58259-ee22-4cc7-9f67-73e49d670d43",
  "security_group_name" : "test111-cce-node-5i32n",
  "security_group_description" : "The security group is created by CCE cluster c0276ccf-aaf4-11ee-9d4a-0255ac100b0f for the node"
} ]

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档