# 查询遵从包列表 - SearchCompliancePackages #### 功能介绍 查询遵从包列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v2/{project_id}/workspaces/{workspace_id}/sa/baseline/compliance-packages/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | | X-Language | 是 | String | **参数解释：** 语言，参考值：zh-cn、en-us **约束限制：** 不涉及 **取值范围：** zh-cn：中文环境 en-us：英文环境 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 分页大小 | | offset | 否 | Integer | 偏移量 | | name | 否 | String | 遵从包名称 | | description | 否 | String | 遵从包描述 | | type | 否 | Integer | 表示该遵从包的类型 0：内置 1: 自定义 | | state | 否 | Integer | 表示该遵从包的状态 0：停用 1: 启用 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 遵从包总数 | | builtin_compliance_num | Integer | 内置遵从包数量 | | customized_compliance_num | Integer | 自定义遵从包数量 | | disabled_compliance_num | Integer | 停用遵从包数量 | | enabled_compliance_num | Integer | 启用遵从包数量 | | compliance_packages | Array of [CompliancePackageModel] objects | 遵从包列表 | 表5CompliancePackageModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uuid | String | 遵从包的uuid | | name | String | 遵从包的名称 | | version | String | 遵从包的版本号 | | owner | String | 遵从包的责任人 | | spec_catalog_vo_list | Array of [BaselineCatalogModel] objects | 遵从包的目录列表 | | description | String | 对遵从包的描述 | | classify | String | 遵从包的分类 | | areas | String | 遵从包适用的领域 | | region | String | 遵从包适用的区域 | | state | Integer | 表示遵从包的状态 0：未启用 1: 启用 | | type | Integer | 表示遵从包的类型 0：内置 1: 自定义 | | check_items_num | Integer | 表示该遵从包包含的检查项个数 | | has_auto_check_items | Boolean | 表示该遵从包是否包含自动检查项 | 表6BaselineCatalogModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uuid | String | 目录ID唯一标识，UUID | | serial_number | Integer | 目录的位置顺序 | | level_number | Integer | 目录的层级关系 | | root | String | 该目录所在遵从包UUID | | parent | String | 该目录的父目录UUID，如果等于为第一层目录，则为遵从包UUID | | is_leaf | Boolean | 该目录是否是叶子节点 0：不是 1：是 | | check_items | Array of [CheckitemCatalogModel] objects | 目录关联的检查项 | 表7CheckitemCatalogModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uuid | String | 检查项uuid | | name | String | 检查项的名称 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | message | String | **参数解释：** 错误描述 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | message | String | **参数解释：** 错误描述 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | message | String | **参数解释：** 错误描述 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求示例 查询遵从包列表请求样例，例如查询内置遵从包，返回第一页，每页10条数据 ``` https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/sa/baseline/compliance-packages/search { "limit" : 10, "offset" : 0 } ``` #### 响应示例 **状态码：200** 查询基线检查遵从包列表返回体 ``` { "count" : 10, "builtin_compliance_num" : 10, "customized_compliance_num" : 10, "disabled_compliance_num" : 10, "enabled_compliance_num" : 10, "compliance_packages" : [ { "uuid" : "102c8876-f111-4ee9-b499-80450711df6f", "name" : "testForApie", "version" : "1.0", "owner" : "l123", "spec_catalog_vo_list" : [ { "uuid" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "serial_number" : 2, "level_number" : 0, "root" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "parent" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "is_leaf" : true, "check_items" : [ { "uuid" : "3f9d8c0e-2a1b-4d3c-9a7b-1f2e3d4c5b6a", "name" : "test checkitem" } ] } ], "description" : "test spec", "classify" : "test", "areas" : "test", "region" : "test", "state" : 0, "type" : 0, "check_items_num" : 0, "has_auto_check_items" : true } ] } ``` **状态码：400** 请求失败 ``` { "error_code" : "SecMaster.00040006", "error_msg" : "Invalid request parameters" } ``` **状态码：401** 权限不足 ``` { "error_code" : "SecMaster.90010015", "error_msg" : "Unauthorized request" } ``` **状态码：500** 请求失败 ``` { "error_code" : "SecMaster.00040011", "error_msg" : "Internal system error" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询遵从包列表请求样例，例如查询内置遵从包，返回第一页，每页10条数据 ``` 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.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class SearchCompliancePackagesSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); SearchCompliancePackagesRequest request = new SearchCompliancePackagesRequest(); request.withWorkspaceId("{workspace_id}"); SearchCompliancePackagesRequestBody body = new SearchCompliancePackagesRequestBody(); body.withOffset(0); body.withLimit(10); request.withBody(body); try { SearchCompliancePackagesResponse response = client.searchCompliancePackages(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] 查询遵从包列表请求样例，例如查询内置遵从包，返回第一页，每页10条数据 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = SearchCompliancePackagesRequest() request.workspace_id = "{workspace_id}" request.body = SearchCompliancePackagesRequestBody( offset=0, limit=10 ) response = client.search_compliance_packages(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] 查询遵从包列表请求样例，例如查询内置遵从包，返回第一页，每页10条数据 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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 := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.SearchCompliancePackagesRequest{} request.WorkspaceId = "{workspace_id}" offsetSearchCompliancePackagesRequestBody:= int32(0) limitSearchCompliancePackagesRequestBody:= int32(10) request.Body = &model.SearchCompliancePackagesRequestBody{ Offset: &offsetSearchCompliancePackagesRequestBody, Limit: &limitSearchCompliancePackagesRequestBody, } response, err := client.SearchCompliancePackages(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=SearchCompliancePackages&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询基线检查遵从包列表返回体 | | 400 | 请求失败 | | 401 | 权限不足 | | 500 | 请求失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。