Querying the Compliance Results of a Resource
Function
This API is used to query all compliance results of a resource evaluated by rules. The resource is searched by resource ID.
Calling Method
For details, see Calling APIs.
URI
GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/policy-states
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies tags. Maximum: 36 |
resource_id |
Yes |
String |
Specifies the resource ID. Maximum: 512 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
compliance_state |
No |
String |
Specifies the compliance status. Maximum: 16 |
limit |
No |
Integer |
Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200 |
marker |
No |
String |
Specifies the pagination parameter. Minimum: 4 Maximum: 400 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Specifies the invoker's token. |
X-Security-Token |
No |
String |
Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
value |
Array of PolicyState objects |
Specifies the return value of querying the compliance result. |
page_info |
PageInfo object |
Specifies the pagination object. |
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. |
Parameter |
Type |
Description |
---|---|---|
current_count |
Integer |
Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200 |
next_marker |
String |
Specifies the marker value of the next page. Minimum: 4 Maximum: 400 |
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: 404
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
None
Example Responses
Status code: 200
Operation succeeded.
{ "value" : [ { "domain_id" : "059b5c937100d3e40ff0c00a7675a0a0", "region_id" : "regionid1", "resource_id" : "010d95bd-87cd-4f22-ac00-db7fba7d927e", "resource_name" : "ecs-cc-image-test1", "resource_provider" : "ecs", "resource_type" : "cloudservers", "compliance_state" : "NonCompliant", "policy_assignment_id" : "5fb618a726a24c53767fa049", "policy_assignment_name" : "policy-assignment-test1", "policy_definition_id" : "5fa265c0aa1e6afc05a0ff07", "evaluation_time" : 1605776482523 } ], "page_info" : { "current_count" : 1, "next_marker" : null } }
Status Codes
Status Code |
Description |
---|---|
200 |
Operation succeeded. |
400 |
Invalid parameters. |
403 |
Authentication failed or you do not have the operation permissions. |
404 |
Resources not found. |
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