文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 获取资源的合规结果
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

获取资源的合规结果

功能介绍

根据资源ID查询所有合规结果。

调用方法

请参见如何调用API。

URI

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/policy-states

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

账号ID。

最大长度：36

resource_id

是

String

资源ID。

最大长度：512
表2 Query参数

参数

是否必选

参数类型

描述

compliance_state

否

String

合规结果。

最大长度：16

limit

否

Integer

最大的返回数量。

最小值：1

最大值：200

缺省值：200

marker

否

String

分页参数，通过上一个请求中返回的marker信息作为输入，获取当前页。

最小长度：4

最大长度：400

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

调用者token。

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

value

Array of PolicyState objects

合规结果查询返回值。

page_info

PageInfo object

分页对象。
表5 PolicyState

参数

参数类型

描述

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

合规状态评估时间。
表6 PageInfo

参数

参数类型

描述

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

错误消息内容。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

无

响应示例

状态码： 200

操作成功。

{
  "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",
    "trigger_type" : "resource",
    "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
  }
}

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

认证失败或没有操作权限。

404

资源未找到。

500

服务器内部错误。

错误码

请参见错误码。

父主题： 合规性