接口查询OPA策略详情,入参为策略名,策略名由创建时传入的crContent中指定。
接口URL:/csm/v1/open/opa/policy/detail
Content-Type:text/plain
请求方式:GET
URI参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
service_mesh_id | e779bd8***** | String | 是 | 服务网格id |
namespace | default | String | 是 | 命名空间 |
name | object-policy-dd | String | 是 | 策略名 |
请求体参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
无请求参数KEY/VALUE类型 |
返回参数说明:
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
code | CSM_2000 | String | 错误码 |
message | SUCCESS | String | 错误提示信息 |
returnObj | Object | Object | API返回数据体,接口如果没有返回字段时也可能可能返回{}或[] |
statusCode | 2000 | Integer | 调用错误时返回的错误编码 |
表returnObj
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
metadata | Object | Object | OPA策略元数据 |
spec | Object | Object | OPA策略详细属性 |
表metadata
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
creationTimestamp | String | String | 创建时间 |
labels | Object | map[string]string | 标签 |
name | String | String | OPA策略名 |
namespace | String | String | 命名空间 |
resourceVersion | String | String | 资源版本 |
表spec
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
policy | String | String | 具体策略,rego语法 |
workloadSelector | Object | Object | 策略生效范围,以labels为准 |
表workloadSelector
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
labels | Object | map[string]string | 标签 |
返回示例:成功
{
"code": "CSM_2000",
"message": "SUCCESS",
"returnObj": {
"metadata": {
"creationTimestamp": "string",
"labels": {
"version": "string"
},
"name": "string",
"namespace": "string",
"resourceVersion": "string"
},
"spec": {
"policy": "package istio.authz\nimport input.attributes.request.http as http_request\ndefault allow = false",
"workloadSelector": {
"labels": {
"version": "string"
}
}
}
},
"statusCode": 2000
}
返回示例:失败(详见接口失败示例章节)