# 更新合规评估结果 - UpdatePolicyState #### 功能介绍 更新用户自定义合规规则的合规评估结果。 #### 调用方法 请参见[如何调用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)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rms:policyStates:update | Write | - | - | - | - | #### URI PUT /v1/resource-manager/domains/{domain_id}/policy-states 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 账号ID。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字及"_"、"-"组成，且长度为\[1\~36\]个字符。 **默认取值**： 不涉及 最大长度：**36** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释**： 调用者token。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy_resource | 是 | [PolicyResource] object | **参数解释**： 指定资源。 **约束限制**： 不涉及 | | trigger_type | 是 | String | **参数解释**： 触发器类型。 **约束限制**： 不涉及 **取值范围**： - resource：配置变更 - period：周期执行 **默认取值**： 不涉及 | | compliance_state | 是 | String | **参数解释**： 合规结果。 **约束限制**： 不涉及 **取值范围**： - NonCompliant：不合规 - Compliant：合规 **默认取值**： 不涉及 | | policy_assignment_id | 是 | String | **参数解释**： 规则ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | policy_assignment_name | 否 | String | **参数解释**： 规则名称。 **约束限制**： 长度为\[1-256\]个字符 **取值范围**： 不涉及 **默认取值**： 不涉及 最大长度：**256** | | evaluation_time | 是 | String | **参数解释**： 合规状态评估时间。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | evaluation_hash | 是 | String | **参数解释**： 评估校验码。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表4PolicyResource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_id | 否 | String | **参数解释**： 资源ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_name | 否 | String | **参数解释**： 资源名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_provider | 否 | String | **参数解释**： 云服务名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | resource_type | 否 | String | **参数解释**： 资源类型。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | region_id | 否 | String | **参数解释**： 区域ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | domain_id | 否 | String | **参数解释**： 资源所属用户ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain_id | String | **参数解释**： 账号ID。 **取值范围**： 不涉及 | | region_id | String | **参数解释**： 资源区域ID。 **取值范围**： 不涉及 | | resource_id | String | **参数解释**： 资源ID。 **取值范围**： 不涉及 | | resource_name | String | **参数解释**： 资源名称。 **取值范围**： 不涉及 | | resource_provider | String | **参数解释**： 云服务名称。 **取值范围**： 不涉及 | | resource_type | String | **参数解释**： 资源类型。 **取值范围**： 不涉及 | | trigger_type | String | **参数解释**： 触发器类型。 **取值范围**： - resource：配置变更 - period：周期执行 | | compliance_state | String | **参数解释**： 合规结果。 **取值范围**： 不涉及 | | policy_assignment_id | String | **参数解释**： 规则ID。 **取值范围**： 不涉及 | | policy_assignment_name | String | **参数解释**： 规则名称。 **取值范围**： 不涉及 | | policy_definition_id | String | **参数解释**： 策略ID。 **取值范围**： 不涉及 | | evaluation_time | String | **参数解释**： 合规状态评估时间。 **取值范围**： 不涉及 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误消息内容。 **取值范围**： 不涉及 | #### 请求示例 functionGraph上报合规评估结果为"NonCompliant"。 ``` PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-states { "policy_resource" : { "domain_id" : "d0123456789", "region_id" : "global", "resource_id" : "abc0123456789", "resource_name" : "test_user", "resource_provider" : "iam", "resource_type" : "users" }, "trigger_type" : "resource", "compliance_state" : "NonCompliant", "policy_assignment_id" : "abc0123456789abc", "policy_assignment_name" : "custom_policy", "evaluation_time" : "1667374060248", "evaluation_hash" : "89342b8f338165651991afb8bd471396" } ``` #### 响应示例 **状态码：200** 操作成功。 ``` { "domain_id" : "d0123456789", "region_id" : "global", "resource_id" : "abc0123456789", "resource_name" : "test_user", "resource_provider" : "iam", "resource_type" : "users", "trigger_type" : "resource", "compliance_state" : "NonCompliant", "policy_assignment_id" : "abc0123456789abc", "policy_assignment_name" : "custom_policy", "policy_definition_id" : null, "evaluation_time" : "1667374060248" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java functionGraph上报合规评估结果为"NonCompliant"。 ``` 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 UpdatePolicyStateSolution { 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(); UpdatePolicyStateRequest request = new UpdatePolicyStateRequest(); PolicyStateRequestBody body = new PolicyStateRequestBody(); PolicyResource policyResourcebody = new PolicyResource(); policyResourcebody.withResourceId("abc0123456789") .withResourceName("test_user") .withResourceProvider("iam") .withResourceType("users") .withRegionId("global") .withDomainId("d0123456789"); body.withEvaluationHash("89342b8f338165651991afb8bd471396"); body.withEvaluationTime("1667374060248"); body.withPolicyAssignmentName("custom_policy"); body.withPolicyAssignmentId("abc0123456789abc"); body.withComplianceState(PolicyStateRequestBody.PolicyStateRequestBody.fromValue("NonCompliant")); body.withTriggerType(PolicyStateRequestBody.PolicyStateRequestBody.fromValue("resource")); body.withPolicyResource(policyResourcebody); request.withBody(body); try { UpdatePolicyStateResponse response = client.updatePolicyState(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 functionGraph上报合规评估结果为"NonCompliant"。 ``` # 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 = UpdatePolicyStateRequest() policyResourcebody = PolicyResource( resource_id="abc0123456789", resource_name="test_user", resource_provider="iam", resource_type="users", region_id="global", domain_id="d0123456789" ) request.body = PolicyStateRequestBody( evaluation_hash="89342b8f338165651991afb8bd471396", evaluation_time="1667374060248", policy_assignment_name="custom_policy", policy_assignment_id="abc0123456789abc", compliance_state="NonCompliant", trigger_type="resource", policy_resource=policyResourcebody ) response = client.update_policy_state(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 functionGraph上报合规评估结果为"NonCompliant"。 ``` 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.UpdatePolicyStateRequest{} resourceIdPolicyResource:= "abc0123456789" resourceNamePolicyResource:= "test_user" resourceProviderPolicyResource:= "iam" resourceTypePolicyResource:= "users" regionIdPolicyResource:= "global" domainIdPolicyResource:= "d0123456789" policyResourcebody := &model.PolicyResource{ ResourceId: &resourceIdPolicyResource, ResourceName: &resourceNamePolicyResource, ResourceProvider: &resourceProviderPolicyResource, ResourceType: &resourceTypePolicyResource, RegionId: ®ionIdPolicyResource, DomainId: &domainIdPolicyResource, } policyAssignmentNamePolicyStateRequestBody:= "custom_policy" request.Body = &model.PolicyStateRequestBody{ EvaluationHash: "89342b8f338165651991afb8bd471396", EvaluationTime: "1667374060248", PolicyAssignmentName: &policyAssignmentNamePolicyStateRequestBody, PolicyAssignmentId: "abc0123456789abc", ComplianceState: model.GetPolicyStateRequestBodyComplianceStateEnum().NON_COMPLIANT, TriggerType: model.GetPolicyStateRequestBodyTriggerTypeEnum().RESOURCE, PolicyResource: policyResourcebody, } response, err := client.UpdatePolicyState(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=UpdatePolicyState)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 输入参数不合法。 | | 403 | 用户认证失败或无操作权限。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rms/ErrorCode.html)。