文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 获取单个合规规则
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

获取单个合规规则

功能介绍

根据规则ID获取单个规则。

调用方法

请参见如何调用API。

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

账号ID。

最大长度：36

policy_assignment_id

是

String

规则ID。

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

调用者token。

X-Security-Token

否

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

policy_assignment_type

String

规则类型，包括预定义合规规则(builtin)和用户自定义合规规则(custom)

id

String

规则ID。

name

String

规则名称。

description

String

规则描述。

policy_filter

PolicyFilterDefinition object

规则过滤器。

period

String

周期值，可选值：One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

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。
表4 PolicyFilterDefinition

参数

参数类型

描述

region_id

String

区域ID。

最大长度：128

resource_provider

String

云服务名称。

最大长度：128

resource_type

String

资源类型。

最大长度：128

resource_id

String

资源ID。

最大长度：512

tag_key

String

标签键。

最大长度：128

tag_value

String

标签值。

最大长度：256
表5 CustomPolicy

参数

参数类型

描述

function_urn

String

自定义函数的URN

最大长度：1024

auth_type

String

自定义合规规则调用function方式

auth_value

Map<String,Object>

自定义合规规则调用function方式的参数值
表6 PolicyParameterValue

参数

参数类型

描述

value

Object

规则参数值。
表7 ResourceTag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。 key符合3.1 KEY字符集规范。

最小长度：1

最大长度：128

value

String

值。每个值最大长度255个unicode字符。value符合3.2 VALUE字符集规范。

最小长度：0

最大长度：255

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

无

响应示例

状态码： 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
  },
  "state" : "Enabled",
  "period" : null,
  "custom_policy" : null,
  "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
}

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

404

合规规则未找到。

500

服务器内部错误。

错误码

请参见错误码。

父主题： 合规性