云容器引擎-获取集群策略治理详情
接口功能介绍
调用该接口查看集群策略治理详情
接口约束
无
URI
GET /v1.1/ccse/clusters/*/policies/governance
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clusterName | 是 | String | 集群名称 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | 800 | |
message | String | 提示信息 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码 | CCSE_500 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
onState | Array of Objects | 当前集群中开启的不同等级策略计数统计 | onState | |
violations | Object | 集群中针对不同策略类型的拦截和告警的审计计数统计列表 | violations | |
admitLog | Object | 集群当前策略治理审计日志 | admitLog |
表 onState
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
severity | String | 策略治理等级 | ||
total | Long | 该等级下策略种类总数 | ||
enabledCount | Long | 当前开启的策略种类计数 |
表 violations
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
deny | Array of Objects | 拦截模式下不同治理等级的违规计数统计 | deny | |
warn | Array of Objects | 告警模式下不同治理等级的违规计数统计 | warn | |
denyCount | Object | 告警模式下High治理等级的违规计数统计 | denyCount | |
warnCount | Object | 告警模式下Medium治理等级的违规计数统计 | warnCount |
表 deny
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policyName | String | 策略名称 | ||
policyDesc | String | 策略描述 | ||
violations | Integer | 集群中对应规则类型下被拦截的违规计数统计 | 1 | |
severity | String | 策略治理等级 |
表 warn
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policyName | String | 策略名称 | ||
policyDesc | String | 策略描述 | ||
violations | Integer | 集群中对应规则类型下被拦截的违规计数统计 | 1 | |
severity | String | 策略治理等级 |
表 denyCount
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
high | Integer | 高级别违规计数统计 | 1 | |
medium | Integer | 中级别违规计数统计 | 1 | |
low | Integer | 低级别违规计数统计 | 1 |
表 warnCount
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
high | Integer | 高级别违规计数统计 | 1 | |
medium | Integer | 中级别违规计数统计 | 1 | |
low | Integer | 低级别违规计数统计 | 1 |
表 admitLog
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
progress | String | 查询结果的状态:Complete, Incomplete | ||
count | Long | 当前查询到的日志总数 | 123 | |
log | Array of Objects | 策略治理审计日志内容 | log |
表 log
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
clusterId | Long | 目标集群ID | 12345678 | |
constraintKind | Long | 策略类型名称 | 123 | |
resourceName | String | 目标资源名称 | ||
resourceKind | String | 目标资源类型 | ||
resourceNamespace | String | 目标资源命名空间 | ||
msg | String | 策略治理审计日志信息 |
枚举参数
无
请求示例
请求url
GET https://ccse-global.ctapi.ctyun.cn/v1.1/ccse/clusters/test/policies/governance
请求头header
{
regionId:bb9fdb42056f11eda1610242ac110002
}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "获取集群ccse-g60567策略治理详情",
"returnObj": {
"onState": [
{
"severity": "high",
"total": 15,
"enabledCount": 1
},
{
"severity": "low",
"total": 13,
"enabledCount": 1
},
{
"severity": "medium",
"total": 10,
"enabledCount": null
}
],
"violations": {
"deny": [],
"warn": [
{
"policyName": "CCSERequiredLabels",
"policyDesc": "限制在集群指定范围内部署没有指定范式label标签的应用。",
"violations": 4,
"severity": "low"
}
],
"denyCount": {
"high": 0,
"low": 0,
"medium": 0
},
"warnCount": {
"high": 0,
"low": 4,
"medium": 0
}
},
"admitLog": null
}
}