校验策略
功能介绍
校验策略并返回格式化的策略文档或错误信息。
URI
POST /v5/internal/policies/validate
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policy_document |
是 |
String |
该策略JSON格式策略文档。 |
|
policy_type |
是 |
String |
要校验的策略类型。 |
|
validate_policy_resource_type |
否 |
String |
要附加到资源策略的资源类型。 |
|
size_limited |
是 |
Boolean |
是否检查策略长度。 |
|
account_id |
否 |
String |
要校验的账号ID。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
verdict |
String |
校验结果。 |
|
formatted_document |
String |
该策略JSON格式策略文档。 |
|
error_finding |
ValidatePolicyErrorFinding object |
策略校验结果。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
finding_details |
String |
一条英文消息提供了如何解决该问题的指导。 |
|
issue_code |
String |
问题码提供了与此校验结果关联的问题的标识符。 |
|
locations |
Array of Location objects |
策略文档中与校验结果相关的位置列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
path |
Array of PathElement objects |
策略中的路径，表示为路径元素的有序序列。 |
|
span |
Span object |
光标在策略文本中的范围。范围由开始位置（含）和结束位置（不含）组成。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
index |
Integer |
数组中的索引，从0开始。 |
|
key |
String |
对象中的键。 |
|
substring |
Substring object |
JSON反序列化后的字符串的子串。 |
|
value |
String |
与对象中给定键关联的值。 |
请求示例
校验策略并返回格式化的策略文档或错误信息。
POST https://{hostname}/v5/internal/policies/validate
{
"policy_document" : "",
"policy_type" : "identity_policy",
"size_limited" : true
}
响应示例
状态码：200
OK
{
"verdict" : "error",
"error_finding" : {
"finding_details" : "Fix the JSON syntax error at character 0 in line 1 with index 0.",
"issue_code" : "JSON_SYNTAX_ERROR",
"locations" : [ {
"path" : [ ],
"span" : {
"start" : {
"line" : 1,
"column" : 0,
"offset" : 0
},
"end" : {
"line" : 1,
"column" : 1,
"offset" : 1
}
}
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
