文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器网络隔离信息/ 查询云原生网络模式2.0的集群已配置的安全组策略 - ListSecurityGroupPolicies
更新时间:2025-10-31 GMT+08:00
分享

查询云原生网络模式2.0的集群已配置的安全组策略 - ListSecurityGroupPolicies

功能介绍

查询云原生网络模式2.0的集群已配置的安全组策略

授权信息

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

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

URI

GET /v5/{project_id}/container-network/{cluster_id}/security-group-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

cluster_id

String

集群id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总共记录数

data_list

Array of SecurityGroupPolicyResponseInfo objects

数据列表

last_update_time

Long

数据最近同步时间

表5 SecurityGroupPolicyResponseInfo

参数

参数类型

描述

policy_id

String

策略Id

policy_name

String

策略名称

pod_selector

String

选择器

security_groups

Array of SecurityGroup objects

安全组列表

workload_id

String

工作负载ID

workload_name

String

工作负载名称

workload_type

String

工作负载类型

namespace_id

String

命名空间id

namespace

String

命名空间

create_time

String

创建时间

policy_content

String

策略yaml格式内容

表6 SecurityGroup

参数

参数类型

描述

security_group_id

String

安全组ID

security_group_name

String

安全组名称

security_group_description

String

安全组描述

请求示例

查询云原生网络模式2.0的集群已配置的安全组策略

GET https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/security-group-policies?offset=0&limit=200&enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "total_num" : 20,
  "data_list" : [ {
    "policy_id" : "07ffd721-1a1a-4e0a-9479-11e72f5049b0",
    "policy_name" : "gz-test",
    "pod_selector" : "{\"app\":\"log-agent-log-operator\",\"release\":\"cceaddon-log-agent\"}",
    "security_groups" : [ {
      "security_group_id" : "6daf50f9-88d8-44f8-84d2-4426b255314a",
      "security_group_name" : "gz-test",
      "security_group_description" : "测试用安全组"
    } ],
    "workload_id" : "3d30ed8a-5534-4b41-9977-dbd83aa22b34",
    "workload_name" : "log-agent-log-operato",
    "workload_type" : "deployments",
    "namespace" : "monitoring",
    "namespace_id" : "dd12895a-fda4-45fb-815f-044f410f75de",
    "create_time" : "1710332874658",
    "policy_content" : "{\"apiVersion\":\"crd.yangtse.cni/v1\",\"kind\":\"SecurityGroup\",\"metadata\":{\"generation\":1,\"finalizers\":[\"yangtse.io/security-group-cleanup\"],\"uid\":\"07ffd721-1a1a-4e0a-9479-11e72f5049b0\",\"managedFields\":[{\"apiVersion\":\"crd.yangtse.cni/v1\",\"fieldsV1\":{\"f:metadata\":{\"f:labels\":{\"f:app\":{},\".\":{}}},\"f:spec\":{\"f:podSelector\":{\"f:matchLabels\":{\"f:app\":{},\"f:release\":{},\".\":{}},\".\":{}},\"f:securityGroups\":{},\".\":{}}},\"manager\":\"cfe-apiserver\",\"time\":\"2024-03-08T09:23:43Z\",\"operation\":\"Update\",\"fieldsType\":\"FieldsV1\"},{\"apiVersion\":\"crd.yangtse.cni/v1\",\"fieldsV1\":{\"f:metadata\":{\"f:finalizers\":{\"v:\\\"yangtse.io/security-group-cleanup\\\"\":{},\".\":{}}}},\"manager\":\"controller\",\"time\":\"2024-03-08T09:23:43Z\",\"operation\":\"Update\",\"fieldsType\":\"FieldsV1\"}],\"resourceVersion\":\"10362662\",\"creationTimestamp\":\"2024-03-08T09:23:43Z\",\"name\":\"glz-test\",\"namespace\":\"monitoring\",\"labels\":{\"app\":\"log-agent-log-operator\"}},\"spec\":{\"podSelector\":{\"matchLabels\":{\"app\":\"log-agent-log-operator\",\"release\":\"cceaddon-log-agent\"}},\"securityGroups\":[{\"id\":\"6daf50f9-88d8-44f8-84d2-4426b255315a\"}]}}"
  } ],
  "last_update_time" : 1743644574000
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档