创建合规规则 - CreatePolicyAssignments
功能介绍
创建新的合规规则。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
PUT /v1/resource-manager/domains/{domain_id}/policy-assignments
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 账号ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符。 默认取值: 不涉及 最大长度:36 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 调用者token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy_assignment_type | 否 | String | 参数解释: 合规规则类型。 约束限制: builtin类型的合规规则需传policy_definition_id字段,custom类型的合规规则需传custom_policy字段。 取值范围: 默认取值: builtin |
| name | 是 | String | 参数解释: 合规规则名称。 约束限制: 不涉及 取值范围: 长度为[1~256]个字符 默认取值: 不涉及 最大长度:256 |
| description | 否 | String | 参数解释: 合规规则描述。 约束限制: 不涉及 取值范围: 长度为[0~512]个字符 默认取值: 不涉及 最大长度:512 |
| period | 否 | String | 参数解释: 周期规则触发周期 约束限制: 仅创建周期规则时需要传递该参数 取值范围: 默认取值: 不涉及 |
| policy_filter | 否 | PolicyFilterDefinition object | 参数解释: 合规规则仅评估满足以下条件的资源,该字段已不推荐使用,推荐使用PolicyFilterDefinitionV2字段。 约束限制: PolicyFilterDefinition与PolicyFilterDefinitionV2字段互斥,不允许同时传参。 默认取值: 不涉及 |
| policy_filter_v2 | 否 | PolicyFilterDefinitionV2 object | 参数解释: 合规规则仅评估满足以下条件的资源,与PolicyFilterDefinition字段相比,支持更灵活的资源过滤条件。 约束限制: PolicyFilterDefinition与PolicyFilterDefinitionV2字段互斥,不允许同时传参。 默认取值: 不涉及 |
| policy_definition_id | 否 | String | 参数解释: 策略定义ID 约束限制: Config预定义规则策略ID,仅创建预定义规则时需传递该参数 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符 默认取值: 不涉及 最大长度:36 |
| custom_policy | 否 | CustomPolicy object | 参数解释: 自定义合规规则 约束限制: 不涉及 |
| parameters | 否 | Map<String,PolicyParameterValue> | 参数解释: 合规规则参数。 约束限制: 不涉及 |
| tags | 否 | Array of ResourceTag objects | 参数解释: 标签列表 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 否 | String | 参数解释: 区域ID。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| resource_provider | 否 | String | 参数解释: 云服务名称。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| resource_type | 否 | String | 参数解释: 资源类型。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| resource_id | 否 | String | 参数解释: 资源ID。 约束限制: 不涉及 取值范围: 长度为[1~512]个字符。 默认取值: 不涉及 最大长度:512 |
| tag_key | 否 | String | 参数解释: 标签键。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| tag_value | 否 | String | 参数解释: 标签值。 约束限制: 不涉及 取值范围: 长度为[1~256]个字符。 默认取值: 不涉及 最大长度:256 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_ids | 否 | Array of strings | 参数解释: 区域ID列表 约束限制: 不涉及 |
| resource_types | 否 | Array of strings | 参数解释: 云服务列表 约束限制: 不涉及 |
| resource_ids | 否 | Array of strings | 参数解释: 资源ID列表 约束限制: 不涉及 |
| tag_key_logic | 否 | String | 参数解释: 参数tags的取值逻辑,例如tags设置了a:a和b:b,当取值AND时,表示规则仅对同时绑定了a:a和b:b的资源生效;当取值为OR时,表示规则对任何绑定了a:a或b:b的资源生效。 约束限制: 不涉及 取值范围: 默认取值: OR 缺省值:OR |
| tags | 否 | Array of FilterTagDetail objects | 参数解释: 生效标签列表 约束限制: 不涉及 |
| exclude_tag_key_logic | 否 | String | 参数解释: 参数exclude_tags的取值逻辑,例如exclude_tags设置了a:a和b:b,当取值AND时,表示规则仅对同时绑定了a:a和b:b的资源生效;当取值为OR时,表示规则对任何绑定了a:a或b:b的资源生效。 约束限制: 不涉及 取值范围: 默认取值: OR 缺省值:OR |
| exclude_tags | 否 | Array of FilterTagDetail objects | 参数解释: 排除标签列表,排除标签列表比生效标签列表有更高的优先级 约束限制: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 否 | String | 参数解释: 标签key 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| values | 否 | Array of strings | 参数解释: 标签值列表 约束限制: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy_assignment_type | String | 参数解释: 规则类型。 取值范围: |
| id | String | 参数解释: 规则ID。 取值范围: 不涉及 |
| name | String | 参数解释: 规则名称。 取值范围: 不涉及 |
| description | String | 参数解释: 规则描述。 取值范围: 不涉及 |
| policy_filter | PolicyFilterDefinition object | 参数解释: 合规规则仅评估满足以下条件的资源,该字段已不推荐使用,推荐使用PolicyFilterDefinitionV2字段。 约束限制: PolicyFilterDefinition与PolicyFilterDefinitionV2字段互斥,不允许同时传参。 默认取值: 不涉及 |
| policy_filter_v2 | PolicyFilterDefinitionV2 object | 参数解释: 合规规则仅评估满足以下条件的资源,与PolicyFilterDefinition字段相比,支持更灵活的资源过滤条件。 约束限制: PolicyFilterDefinition与PolicyFilterDefinitionV2字段互斥,不允许同时传参。 默认取值: 不涉及 |
| period | String | 参数解释: 周期值 取值范围: |
| state | String | 参数解释: 规则状态。 取值范围: 不涉及 |
| created | String | 参数解释: 规则创建时间。 取值范围: 不涉及 |
| updated | String | 参数解释: 规则更新时间。 取值范围: 不涉及 |
| policy_definition_id | String | 参数解释: 规则的策略ID。 取值范围: 不涉及 |
| custom_policy | CustomPolicy object | 参数解释: 自定义合规规则 约束限制: 不涉及 |
| parameters | Map<String,PolicyParameterValue> | 参数解释: 规则参数。 |
| tags | Array of ResourceTag objects | 参数解释: 标签列表 |
| created_by | String | 参数解释: 规则的创建者 取值范围: 不涉及 |
| target_type | String | 参数解释: 合规规则修正方式。 取值范围: |
| target_id | String | 参数解释: 修正执行的目标id。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| region_id | String | 参数解释: 区域ID。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| resource_provider | String | 参数解释: 云服务名称。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| resource_type | String | 参数解释: 资源类型。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| resource_id | String | 参数解释: 资源ID。 约束限制: 不涉及 取值范围: 长度为[1~512]个字符。 默认取值: 不涉及 最大长度:512 |
| tag_key | String | 参数解释: 标签键。 约束限制: 不涉及 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及 最大长度:128 |
| tag_value | String | 参数解释: 标签值。 约束限制: 不涉及 取值范围: 长度为[1~256]个字符。 默认取值: 不涉及 最大长度:256 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| region_ids | Array of strings | 参数解释: 区域ID列表 约束限制: 不涉及 |
| resource_types | Array of strings | 参数解释: 云服务列表 约束限制: 不涉及 |
| resource_ids | Array of strings | 参数解释: 资源ID列表 约束限制: 不涉及 |
| tag_key_logic | String | 参数解释: 参数tags的取值逻辑,例如tags设置了a:a和b:b,当取值AND时,表示规则仅对同时绑定了a:a和b:b的资源生效;当取值为OR时,表示规则对任何绑定了a:a或b:b的资源生效。 约束限制: 不涉及 取值范围: 默认取值: OR 缺省值:OR |
| tags | Array of FilterTagDetail objects | 参数解释: 生效标签列表 约束限制: 不涉及 |
| exclude_tag_key_logic | String | 参数解释: 参数exclude_tags的取值逻辑,例如exclude_tags设置了a:a和b:b,当取值AND时,表示规则仅对同时绑定了a:a和b:b的资源生效;当取值为OR时,表示规则对任何绑定了a:a或b:b的资源生效。 约束限制: 不涉及 取值范围: 默认取值: OR 缺省值:OR |
| exclude_tags | Array of FilterTagDetail objects | 参数解释: 排除标签列表,排除标签列表比生效标签列表有更高的优先级 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签key 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| values | Array of strings | 参数解释: 标签值列表 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| function_urn | String | 参数解释: 自定义函数的URN,可以在FunctionGraph服务函数列表获取 约束限制: 不涉及 取值范围: 长度为[1~1024]个字符 默认取值: 不涉及 最大长度:1024 |
| auth_type | String | 参数解释: 自定义合规规则调用function方式。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| auth_value | Map<String,Object> | 参数解释: 自定义合规规则调用function方式的参数值 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键。 约束限制: key符合3.1 KEY字符集规范。 取值范围: 长度为[1-128]个unicode字符。 默认取值: 不涉及 最小长度:1 最大长度:128 |
| value | String | 参数解释: 标签值。 约束限制: value符合3.2 VALUE字符集规范。 取值范围: 长度为[0-255]个unicode字符。 默认取值: 不涉及 最小长度:0 最大长度:255 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
请求示例
创建一个名为“allowed-images-by-id”的合规规则。
PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments
{
"name" : "allowed-images-by-id",
"description" : "The ECS resource is non-compliant if the image it used is not in the allowed list",
"parameters" : {
"listOfAllowedImages" : {
"value" : [ "ea0d6e0e-99c3-406d-a873-3bb45462b624" ]
}
},
"policy_filter" : {
"resource_provider" : "ecs",
"resource_type" : "cloudservers"
},
"policy_definition_id" : "5f3c8b9a9811a13739a32ed9",
"tags" : [ {
"key" : "tagkey",
"value" : "tagValue"
} ]
} 响应示例
状态码:200
操作成功。
{
"policy_assignment_type" : "builtin",
"id" : "5fb76a240f2daf0b9662a04d",
"name" : "volume-inuse-check",
"description" : "云硬盘未挂载给任何云服务器,视为“不合规”。",
"policy_filter" : {
"region_id" : null,
"resource_provider" : "evs",
"resource_type" : "volumes",
"resource_id" : null,
"tag_key" : null,
"tag_value" : null
},
"period" : null,
"custom_policy" : null,
"state" : "Enabled",
"created" : "2020-11-20T07:03:00",
"updated" : "2020-11-20T07:03:00",
"policy_definition_id" : "5fa36558aa1e6afc05a3d0a7",
"parameters" : { },
"tags" : [ {
"key" : "tagkey",
"value" : "tagValue"
} ],
"created_by" : "custom",
"target_type" : null,
"target_id" : null
} SDK代码示例
SDK代码示例如下。
创建一个名为“allowed-images-by-id”的合规规则。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 | 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.*; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.util.HashMap; public class CreatePolicyAssignmentsSolution { 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("<YOUR REGION>")) .build(); CreatePolicyAssignmentsRequest request = new CreatePolicyAssignmentsRequest(); PolicyAssignmentRequestBody body = new PolicyAssignmentRequestBody(); List<ResourceTag> listbodyTags = new ArrayList<>(); listbodyTags.add( new ResourceTag() .withKey("tagkey") .withValue("tagValue") ); PolicyParameterValue parametersParameters = new PolicyParameterValue(); parametersParameters.withValue("[ea0d6e0e-99c3-406d-a873-3bb45462b624]"); Map<String, PolicyParameterValue> listbodyParameters = new HashMap<>(); listbodyParameters.put("listOfAllowedImages", parametersParameters); PolicyFilterDefinition policyFilterbody = new PolicyFilterDefinition(); policyFilterbody.withResourceProvider("ecs") .withResourceType("cloudservers"); body.withTags(listbodyTags); body.withParameters(listbodyParameters); body.withPolicyDefinitionId("5f3c8b9a9811a13739a32ed9"); body.withPolicyFilter(policyFilterbody); body.withDescription("The ECS resource is non-compliant if the image it used is not in the allowed list"); body.withName("allowed-images-by-id"); request.withBody(body); try { CreatePolicyAssignmentsResponse response = client.createPolicyAssignments(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()); } } } |
创建一个名为“allowed-images-by-id”的合规规则。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | # 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("<YOUR REGION>")) \ .build() try: request = CreatePolicyAssignmentsRequest() listTagsbody = [ ResourceTag( key="tagkey", value="tagValue" ) ] parametersParameters = PolicyParameterValue( value="[ea0d6e0e-99c3-406d-a873-3bb45462b624]" ) listParametersbody = { "listOfAllowedImages": parametersParameters } policyFilterbody = PolicyFilterDefinition( resource_provider="ecs", resource_type="cloudservers" ) request.body = PolicyAssignmentRequestBody( tags=listTagsbody, parameters=listParametersbody, policy_definition_id="5f3c8b9a9811a13739a32ed9", policy_filter=policyFilterbody, description="The ECS resource is non-compliant if the image it used is not in the allowed list", name="allowed-images-by-id" ) response = client.create_policy_assignments(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
创建一个名为“allowed-images-by-id”的合规规则。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := config.NewConfigClient(hcClient) request := &model.CreatePolicyAssignmentsRequest{} var listTagsbody = []model.ResourceTag{ { Key: "tagkey", Value: "tagValue", }, } var valueParameters interface{} = "[ea0d6e0e-99c3-406d-a873-3bb45462b624]" parametersParameters := model.PolicyParameterValue{ Value: &valueParameters, } var listParametersbody = map[string](model.PolicyParameterValue){ "listOfAllowedImages": parametersParameters, } resourceProviderPolicyFilter:= "ecs" resourceTypePolicyFilter:= "cloudservers" policyFilterbody := &model.PolicyFilterDefinition{ ResourceProvider: &resourceProviderPolicyFilter, ResourceType: &resourceTypePolicyFilter, } policyDefinitionIdPolicyAssignmentRequestBody:= "5f3c8b9a9811a13739a32ed9" descriptionPolicyAssignmentRequestBody:= "The ECS resource is non-compliant if the image it used is not in the allowed list" request.Body = &model.PolicyAssignmentRequestBody{ Tags: &listTagsbody, Parameters: listParametersbody, PolicyDefinitionId: &policyDefinitionIdPolicyAssignmentRequestBody, PolicyFilter: policyFilterbody, Description: &descriptionPolicyAssignmentRequestBody, Name: "allowed-images-by-id", } response, err := client.CreatePolicyAssignments(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功。 |
| 400 | 输入参数不合法。 |
| 403 | 用户认证失败或无操作权限。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。