# 查询策略组列表，当前仅西南-贵阳一支持 - ListAiPolicyGroups #### 功能介绍 查询策略组列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/ai/policy/groups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，可通过我的凭证，项目id获取 **约束限制**: 必填 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_id | 否 | String | **参数解释**: 策略组ID **约束限制**: 不涉及 **取值范围**: 字符长度1-20位 **默认取值**: 不涉及 | | group_name | 否 | String | **参数解释**： 策略组名称 **约束限制**： 不涉及 **取值范围**： 字符长度1-128位 **默认取值**： 不涉及 | | protection_object | 否 | String | **参数解释**： 防护对象 **约束限制**： 不涉及 **取值范围**： 字符长度1-128位 **默认取值**： 不涉及 | | object_type | 否 | Integer | **参数解释**: 对象类型 **约束限制**: 不涉及 **取值范围**: - 0：云服务 - 1：三方 **默认取值**: 不涉及 | | offset | 否 | Integer | **参数解释**: 偏移量：指定返回记录的开始位置 **约束限制**: 不涉及 **取值范围**: 最小值0，最大值2000000 **默认取值**: 默认为0 | | limit | 否 | Integer | **参数解释**: 每页显示个数 **约束限制**: 不涉及 **取值范围**: 取值10-200 **默认取值**: 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释**: 总数 **取值范围**: 最小值0，最大值2147483647 | | data_list | Array of [AiPolicyGroupInfo] objects | **参数解释**: AI策略组列表 **取值范围**: 不涉及 | 表5AiPolicyGroupInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group_id | String | **参数解释**： 策略组ID **取值范围**： 字符长度1-20位 | | group_name | String | **参数解释**: 策略组名称 **取值范围**: 字符长度1-128位 | | group_type | Integer | **参数解释**： 策略组ID **取值范围**： 最小值0，最大值2147483647 | | project_id | String | 项目ID | | protection_object | String | **参数解释**： 防护对象 **取值范围**： 字符长度1-128位 | | object_type | Integer | **参数解释**: 防护对象类型 **取值范围**: - 0：云服务 - 1：三方 | | object_num | Integer | **参数解释**: 防护对象个数 **取值范围**: 取值0-100000 | | is_default | Boolean | **参数解释**: 是否是默认策略 **取值范围**: - false：否 - true：是 | | is_exclusive | Boolean | **参数解释**: 是否是默认策略 **取值范围**: - false：否 - true：是 | | enabled | Boolean | **参数解释**: 是否启用 **取值范围**: - false：否 - true：是 | | detail_is_used | Boolean | **参数解释**: 是否启用 **取值范围**: - false：否 - true：是 | | description | String | **参数解释**: 描述 **取值范围**: 字符长度0-256位 | | create_time | Integer | **参数解释**： 创建时间 **取值范围**： 最小值0，最大值9223372036854775807 | | update_time | Integer | **参数解释**： 创建时间 **取值范围**： 最小值0，最大值9223372036854775807 | | policy_list | Array of [AiPolicyList] objects | **参数解释**: 策略列表 **取值范围**: 不涉及 | | agent_id_list | Array of strings | **参数解释**: 智能体列表 **取值范围**: 不涉及 | 表6AiPolicyList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_id | String | **参数解释**: 策略ID **取值范围**: 字符长度1-20位 | | policy_name | String | **参数解释**: 策略名称 **取值范围**： - 0: 意图行为一致性检测 - 1: 命令执行控制 - 2: 文件访问控制 - 3: 敏感信息检测 - 4: 角色限定 | | enabled | Boolean | **参数解释**: 是否启用 **取值范围**: - false：否 - true：是 | #### 请求示例 查询策略组列表 ``` GET https://{endpoint}/v5/{project_id}/ai/policy/groups ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 3, "data_list" : [ { "group_id" : "2058116443399700480", "group_name" : "xxxx", "project_id" : "84b5266c14ae489fa6549827f032dc62", "protection_object" : "OfficeClaw", "object_type" : 0, "object_num" : 1, "is_default" : true, "enabled" : true, "description" : "1111", "create_time" : 1778874953990, "update_time" : 1779604792737, "policy_list" : null } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListAiPolicyGroupsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("")) .build(); ListAiPolicyGroupsRequest request = new ListAiPolicyGroupsRequest(); try { ListAiPolicyGroupsResponse response = client.listAiPolicyGroups(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("")) \ .build() try: request = ListAiPolicyGroupsRequest() response = client.list_ai_policy_groups(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListAiPolicyGroupsRequest{} response, err := client.ListAiPolicyGroups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListAiPolicyGroups&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。