云容器引擎-获取集群中当前部署的策略实例
接口功能介绍
调用该接口查看集群中当前部署的策略实例
接口约束
无
URI
GET /v1.1/ccse/clusters/*/policies/instances
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clusterName | 是 | String | 目标集群名称 | ccse-demo |
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
policyName | 否 | String | 策略治理规则名称 | CCSENoEnvVarSecrets | |
instanceName | 否 | String | 策略规则实例名称 | allowed-repos-mqdsf |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | 800 | |
message | String | 提示信息 | ||
returnObj | Array of Objects | 返回对象 | returnObj | |
error | String | 错误码 | CCSE_500 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceId | Long | 规则ID | 1 | |
instanceName | String | 实例名称 | CCSERequiredLabels | |
clusterId | Long | 集群标识ID | 1000000 | |
policyName | String | 策略规则名称 | CCSERequireLabels | |
policyCategory | String | 策略模板类型 | k8s-general | |
policyDesc | String | 策略模板描述 | ||
policyParameters | String | 当前规则实例的配置参数 | ||
policySeverity | String | 规则治理等级,取值: high medium low |
low | |
policyScope | String | 策略实例实施范围,默认*代表全部命名空间,否则返回命名空间名称,多个命名空间用逗号分隔 | kube-system | |
policyAction | String | 规则治理动作,取值: deny:拦截违规部署 warn:告警 |
warn | |
status | Integer | 状态,取值: 1:有效 2:删除 |
1 | |
createdTime | String | 创建时间 | 2022-07-06 14:55:33 | |
createdBy | Long | 创建人 | 123 | |
modifiedTime | String | 修改时间 | 2023-06-25 10:01:41 | |
modifiedBy | Long | 修改人 | 123 |
枚举参数
无
请求示例
请求url
GET https://ccse-global.ctapi.ctyun.cn/v1.1/ccse/clusters/ccse-g60567/policies/instances?policyName=xx&instanceName=xx
请求头header
{
regionId:bb9fdb42056f11eda1610242ac110002
}
请求体body
无
响应示例
{
"statusCode": 800,
"message": "获取集群ccse-g60567中部署的策略xx实例xx成功",
"returnObj": [
{
"instanceId": 88,
"instanceName": "must-have-label-test-f0qzk",
"clusterId": "16891471736000002",
"policyName": "CCSERequiredLabels",
"policyCategory": "k8s-general",
"policyDesc": "限制在集群指定范围内部署没有指定范式label标签的应用。",
"policyParameters": "labels: \n- key: test\n allowedRegex: ^test.*$\n",
"policySeverity": "low",
"policyScope": "gatekeeper-system",
"policyAction": "warn",
"status": 1,
"createdBy": 74808,
"createdTime": "2023-07-18 11: 42: 57",
"modifiedBy": null,
"modifiedTime": "2023-07-18 11: 42: 57"
}
]
}