Updating the Compliance Result
Function
This API is used to update the compliance result of a custom rule.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
rms:policyStates:update
Write
-
-
-
-
URI
PUT /v1/resource-manager/domains/{domain_id}/policy-states
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain_id |
Yes |
String |
Specifies the account ID. Maximum: 36 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
Specifies the invoker's token. |
|
X-Security-Token |
No |
String |
Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
policy_resource |
Yes |
PolicyResource object |
Specifies the resource. |
|
trigger_type |
Yes |
String |
Specifies the trigger type. |
|
compliance_state |
Yes |
String |
Specifies the compliance status. |
|
policy_assignment_id |
Yes |
String |
Specifies the policy rule id. |
|
policy_assignment_name |
No |
String |
Specifies the policy rule name. Maximum: 256 |
|
evaluation_time |
Yes |
String |
Specifies when a rule is used to evaluate the resource compliance. |
|
evaluation_hash |
Yes |
String |
Specifies the evaluation verification code. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
resource_id |
No |
String |
Specifies the resource ID. |
|
resource_name |
No |
String |
Specifies the resource name. |
|
resource_provider |
No |
String |
Specifies the cloud service name. |
|
resource_type |
No |
String |
Specifies the resource type. |
|
region_id |
No |
String |
Specifies the region ID. |
|
domain_id |
No |
String |
Specifies the ID of the user to which the resource belongs. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
domain_id |
String |
Specifies the user ID. |
|
region_id |
String |
Specifies the ID of the region the resource belongs to. |
|
resource_id |
String |
Specifies the resource ID. |
|
resource_name |
String |
Specifies the resource name. |
|
resource_provider |
String |
Specifies the cloud service name. |
|
resource_type |
String |
Specifies the resource type. |
|
trigger_type |
String |
Specifies the trigger type. The value can be resource or period. |
|
compliance_state |
String |
Specifies the compliance status. |
|
policy_assignment_id |
String |
Specifies the rule ID. |
|
policy_assignment_name |
String |
Specifies the rule name. |
|
policy_definition_id |
String |
Specifies the policy ID. |
|
evaluation_time |
String |
Specifies the evaluation time of compliance status. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. |
|
error_msg |
String |
Specifies the error message. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. |
|
error_msg |
String |
Specifies the error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. |
|
error_msg |
String |
Specifies the error message. |
Example Requests
The reported compliance result by functionGraph is 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"
}
Example Responses
Status code: 200
Operation succeeded.
{
"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 Sample Code
The SDK sample code is as follows.
The reported compliance result by functionGraph is NonCompliant.
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 |
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("<YOUR REGION>")) .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.ComplianceStateEnum.fromValue("NonCompliant")); body.withTriggerType(PolicyStateRequestBody.TriggerTypeEnum.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()); } } } |
The reported compliance result by functionGraph is NonCompliant.
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 |
# 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 = 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) |
The reported compliance result by functionGraph is NonCompliant.
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 |
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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := config.NewConfigClient( config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Operation succeeded. |
|
400 |
Invalid parameters. |
|
403 |
Authentication failed or you do not have the operation permissions. |
|
500 |
Server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot