# 列举预定义合规规则包模板 - ListBuiltInConformancePackTemplates #### 功能介绍 列举预定义的合规规则包的模板。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-rms/rms_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rms/rms_05_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/resource-manager/conformance-packs/templates 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 最大的返回数量。 **约束限制**： 不涉及 **取值范围**： 1\~200 **默认取值**： 200 最小值：**1** 最大值：**200** 缺省值：**200** | | marker | 否 | String | **参数解释**： 分页参数，通过上一个请求中返回的marker信息作为输入，获取当前页。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字及"_"、"-"、"="、"+"、"/"组成，且长度为\[4\~400\]个字符。 **默认取值**： 不涉及 最小长度：**4** 最大长度：**400** | | template_key | 否 | String | 预定义合规包模板名称。 最小长度：**1** 最大长度：**256** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 否 | String | **参数解释**： 选择接口返回的信息的语言。 **约束限制**： 不涉及 **取值范围**： - zh-cn：中文 - en-us：英文 - fr-fr：法语 - es-us：拉美西班牙语 - pt-br：巴西葡萄牙语 **默认取值**： zh-cn 缺省值：**zh-cn** | | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | Array of [ConformancePackTemplate] objects | 预定义合规规则包模板列表。 | | page_info | [PageInfo] object | **参数解释**： 分页对象。 | 表4ConformancePackTemplate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 预定义合规包模板ID。 | | template_key | String | 预定义合规包模板名称。 | | description | String | 预定义合规包模板描述。 | | template_body | String | 预定义合规包模板内容。 | | parameters | Map\ | 预定义合规包模板参数。 | 表5TemplateParameterDefinition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 预定义合规包模板参数名字。 | | description | String | 预定义合规包模板参数描述。 | | default_value | Object | 预定义合规包模板参数默认值。 | | allowed_values | Array of objects | 预定义合规包模板参数允许值列表。 | | minimum | Float | 策略参数的最小值，当参数类型为Integer或Float时生效。 | | maximum | Float | 策略参数的最大值，当参数类型为Integer或Float时生效。 | | min_items | Integer | 策略参数的最小项数，当参数类型为Array时生效。 | | max_items | Integer | 策略参数的最大项数，当参数类型为Array时生效。 | | min_length | Integer | 策略参数的最小字符串长度或每项的最小字符串长度，当参数类型为String或Array时生效。 | | max_length | Integer | 策略参数的最大字符串长度或每项的最大字符串长度，当参数类型为String或Array时生效。 | | pattern | String | 策略参数的字符串正则要求或每项的字符串正则要求，当参数类型为String或Array时生效。 | | type | String | 预定义合规包模板参数类型。 取值范围： - Array：数组 - Boolean：布尔 - Integer：整型 - Float：浮点数 - String：字符串 | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_count | Integer | **参数解释**： 当前页的资源数量。 **取值范围**： 0-200 | | next_marker | String | **参数解释**： 下一页的marker。 **取值范围**： 长度为\[4\~400\]个字符 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 操作成功。 ``` { "value" : [ { "id" : "k0123456789", "template_key" : "example-001.yaml", "description" : "预定义合规包模板示例。", "template_body" : "Omit it.", "parameters" : { "listOfAllowedFlavors" : { "description" : "The list of allowed flavor types.", "type" : "Array", "default_value" : "STAT", "allowed_values" : [ "STAT" ] } } } ], "page_info" : { "current_count" : 1, "next_marker" : null } } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; public class ListBuiltInConformancePackTemplatesSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("")) .build(); ListBuiltInConformancePackTemplatesRequest request = new ListBuiltInConformancePackTemplatesRequest(); try { ListBuiltInConformancePackTemplatesResponse response = client.listBuiltInConformancePackTemplates(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 GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 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"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("")) \ .build() try: request = ListBuiltInConformancePackTemplatesRequest() response = client.list_built_in_conformance_pack_templates(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/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/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") auth, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := config.ConfigClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := config.NewConfigClient(hcClient) request := &model.ListBuiltInConformancePackTemplatesRequest{} response, err := client.ListBuiltInConformancePackTemplates(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Config/sdk?api=ListBuiltInConformancePackTemplates)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 输入参数不合法。 | | 403 | 用户身份认证失败。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rms/ErrorCode.html)。