云容器引擎-在指定集群中部署策略规则实例
接口功能介绍
调用该接口在指定集群中部署策略规则实例
接口约束
无
URI
POST /v1.1/ccse/clusters//policies/
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clusterName | 是 | String | 集群名称 | ccse-demo | |
policyName | 是 | String | 策略治理规则名称 | CCSENoEnvVarSecrets |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
policyParameters | 是 | Map of String | 实例参数 | {"restrictedNamespaces": [ "test" ]} | |
policyScope | 否 | String | 以逗号分隔的字符串,策略实例实施范围:默认"*"代表集群所有命名空间。 | test3,test4 | |
policyAction | 是 | String | 规则治理动作,取值: deny:拦截违规部署 warn:告警 |
deny |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | 800 | |
message | String | 提示信息 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 错误码 | CCSE_500 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instances | Array of Strings | 部署的实例名称列表 |
枚举参数
无
请求示例
请求url
POST https://ccse-global.ctapi.ctyun.cn/ccse/clusters/ccse-demo/policies/xx
请求头header
{
regionId:bb9fdb42056f11eda1610242ac110002
}
请求体body
{
policyAction:deny,
policyScope:test,
policyParameters:{
restrictedNamespaces:[test]
}
}
响应示例
{
"statusCode": 800,
"message": "部署策略规则实例CCSERequiredLabels成功PolicyInstanceV2DTO(instanceId=12345,
policyParameters=
{
param1=value1,
param2=42,
param3=true
},
policyScope=test,
policyAction=warn)",
"returnObj": {
"instances": [
"must-have-label-test-nd4wn"
]
}
}