文档首页/ 统一身份认证服务 IAM_统一身份认证服务（新版）/ API参考/ API/ Access Analyzer/ 策略校验/ 校验策略
更新时间：2025-09-26 GMT+08:00
查看PDF
分享

校验策略

功能介绍

校验策略并返回结果列表。

URI

POST /v5/policies/validate

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

单页最大结果数。

最小值：1

最大值：200

缺省值：100

marker

否

String

页面标记。

最小长度：4

最大长度：400

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

返回消息的语言，默认值为'zh-cn'。

  • zh-cn：中文

  • en-us：英文

缺省值：zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

policy_document

是

String

该策略JSON格式策略文档。

policy_type

是

String

要校验的策略类型。

  • identity_policy：身份策略

  • resource_policy：资源策略

  • service_control_policy：服务控制策略

validate_policy_resource_type

否

String

要附加到资源策略的资源类型。

  • iam:agency： IAM委托

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

findings

Array of ValidatePolicyFinding objects

可用于改进策略的可操作建议。

page_info

PageInfo object

页面的信息。
表5 ValidatePolicyFinding

参数

参数类型

描述

finding_details

String

一条本地化消息提供了如何解决该问题的指导。

finding_type

String

影响级别。

  • security_warning 安全：策略存在安全风险，可能是允许访问的权限过于宽松等导致。

  • error 错误：存在策略无法运行的错误，如语法错误、参数错误等。存在错误的情况下策略无法创建。

  • warning 警告：存在策略无法运行的警告，如参数取值类型不匹配等。存在警告的情况下策略可以创建。

  • suggestion 建议：不影响策略运行，但策略可能不能达到预期的效果。如存在空数组、空对象条件等。

issue_code

String

问题码提供了与此校验结果关联的问题的标识符。

learn_more_link

String

指向与此校验结果关联的相关文档的链接。

locations

Array of Location objects

策略文档中与校验结果相关的位置列表。
表6 Location

参数

参数类型

描述

path

Array of PathElement objects

策略中的路径，表示为路径元素的有序序列。

span

Span object

光标在策略文本中的范围。范围由开始位置（含）和结束位置（不含）组成。
表7 PathElement

参数

参数类型

描述

index

Integer

数组中的索引，从0开始。

key

String

对象中的键。

substring

Substring object

JSON反序列化后的字符串的子串。

value

String

与对象中给定键关联的值。
表8 Substring

参数

参数类型

描述

start

Integer

子字符串的起始索引，从0开始。0表示第一个字符。

length

Integer

子字符串的长度。
表9 Span

参数

参数类型

描述

start

Position object

策略中的位置。

end

Position object

策略中的位置。
表10 Position

参数

参数类型

描述

line

Integer

位置的行号，从1开始。

column

Integer

位置的列号，从0开始。

offset

Integer

策略中与位置对应的偏移量，从0开始。
表11 PageInfo

参数

参数类型

描述

current_count

Integer

当前页中的项数。

next_marker

String

如果存在更多可用的输出，那么该值表示可用输出比当前响应中包含的更多。在后续调用此操作时，您可以在标记请求参数中使用此值，以获取输出的下一部分。您应该重复这个过程，直到next_marker返回为null。

请求示例

校验策略并返回结果列表。

POST https://{hostname}/v5/policies/validate

{
  "policy_document" : "",
  "policy_type" : "identity_policy"
}

响应示例

状态码：200

OK

{
  "findings" : [ {
    "finding_details" : "修复索引 0 第 1 行第 0 列的 JSON 语法错误。",
    "finding_type" : "error",
    "issue_code" : "JSON_SYNTAX_ERROR",
    "learn_more_link" : "https://{endpoint}/section0",
    "locations" : [ {
      "path" : [ ],
      "span" : {
        "start" : {
          "line" : 1,
          "column" : 0,
          "offset" : 0
        },
        "end" : {
          "line" : 1,
          "column" : 1,
          "offset" : 1
        }
      }
    } ]
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 策略校验

相关文档