云容器引擎-获取集群中策略规则实例详情
接口功能介绍
调用该接口查看集群中策略规则实例详情
接口约束
无
URI
GET /v1.1/ccse/clusters/*/policies/status
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clusterName | 是 | String | 目标集群名称 | ccse-demo |
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
policyName | 否 | String | 策略名称 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | 800 | |
message | String | 提示信息 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码 | CCSE_500 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policyInstances | Array of Objects | 不同策略类型下的策略实例计数列表 | policyInstances | |
instancesSeverityCount | Map of String | Map<String,Object>类型,集群中当前部署的不同治理等级的策略实例计数 | instancesSeverityCount |
表 policyInstances
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policyCategory | String | 策略类型 | cis-k8s | |
policyName | String | 策略名称 | ACKRestrictRoleBindings | |
policyDescription | String | 策略描述 | Restricts use of the cluster-admin role. | |
policySeverity | String | 策略治理等级 | medium | |
policyInstancesCount | Integer | 已部署的策略实例计数 | 1 |
表 instancesSeverityCount
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
high | Integer | 高级别实例数量 | 1 | |
medium | Integer | 中级别实例数量 | 1 | |
low | Integer | 低级别实例数量 | 1 |
枚举参数
无
请求示例
请求url
GET https://ccse-global.ctapi.ctyun.cn/v1.1/ccse/clusters/{clusterName}/policies/status
请求头header
{
regionId:bb9fdb42056f11eda1610242ac110002
}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "获取集群ccse-g60567中部署的策略规则实例详情成功",
"returnObj": {
"policyInstances": [
{
"policyName": "CCSEBlockNodePort",
"policySeverity": "high",
"policyCategory": "k8s-general",
"policyDesc": "限制在集群指定范围内使用NodePort类型的Service。",
"policyInstancesCount": 1
},
{
"policyName": "CCSERequiredLabels",
"policySeverity": "low",
"policyCategory": "k8s-general",
"policyDesc": "限制在集群指定范围内部署没有指定范式label标签的应用。",
"policyInstancesCount": 2
}
],
"instancesSeverityCount": {
"high": 1,
"low": 2
}
}
}