创建访问策略
功能介绍
该API用于创建访问策略。
调用方法
请参见如何调用API。
URI
POST /api/v3/access-policies
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
kind |
否 |
String |
参数解释: API类型。 约束限制: 该值不可修改 取值范围: 不涉及 默认取值: AccessPolicy |
apiVersion |
否 |
String |
参数解释: API版本。 约束限制: 该值不可修改 取值范围: 不涉及 默认取值: v3 |
name |
否 |
String |
参数解释: 访问策略名称。 约束限制: 以小写字母开头,由小写字母、数字、中划线(-)、点(.)组成,长度范围1-56位,且不能以中划线(-)结尾。 取值范围: 不涉及 默认取值: 不涉及 |
clusters |
是 |
Array of strings |
参数解释: 集群ID的列表,允许使用通配符(“*”),表示所有集群。获取方式请参见如何获取接口URI中参数。 约束限制: 当前最多支持同时授权200个集群。 取值范围: ["*"]或者集群ID列表。 默认取值: 不涉及 |
accessScope |
是 |
AccessScope object |
参数解释: 授权范围,指定需要授权的集群及命名空间。 约束限制: 不涉及 |
policyType |
是 |
String |
参数解释: 权限类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
principal |
是 |
Principal object |
参数解释: 授权对象。 约束限制: 不涉及 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
kind |
String |
参数解释: API类型。 约束限制: 该值不可修改。 取值范围: 不涉及 默认取值: AccessPolicy |
apiVersion |
String |
参数解释: API版本。 约束限制: 该值不可修改。 取值范围: 不涉及 默认取值: v3 |
name |
String |
参数解释: 访问策略名称。 约束限制: 以小写字母开头,由小写字母、数字、中划线(-)、点(.)组成,长度范围1-56位,且不能以中划线(-)结尾。 取值范围: 不涉及 默认取值: 不涉及 |
policyId |
String |
参数解释: 权限ID。 约束限制: 系统自动生成,该值不可修改。 取值范围: 不涉及 默认取值: 不涉及 |
clusters |
Array of strings |
参数解释: 集群ID的列表,允许使用通配符(“*”),表示所有集群。 约束限制: 当前最多支持同时授权200个集群。 取值范围: ["*"]或者集群ID列表。 默认取值: 不涉及 |
accessScope |
AccessScope object |
参数解释: 授权范围,指定需要授权的集群及命名空间。 约束限制: 不涉及 |
policyType |
String |
参数解释: 权限类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
principal |
Principal object |
参数解释: 授权对象。 约束限制: 不涉及 |
createTime |
String |
参数解释: 创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
updateTime |
String |
参数解释: 更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
创建访问策略
POST /api/v3/access-policies { "kind" : "AccessPolicy", "apiVersion" : "v3", "name" : "test-access-policy", "accessScope" : { "clusters" : [ "*" ], "namespaces" : [ "*" ] }, "policy" : "CCEAdminPolicy", "principal" : { "type" : "user", "ids" : [ "069fcc2116c347b89869eae3cdxxxxxx1", "069fcc2116c347b89869eae3cdxxxxxx2" ] } }
响应示例
状态码:201
{ "kind" : "AccessPolicy", "apiVersion" : "v3", "name" : "test-access-policy", "policyId" : "402358e8-2e3a-4531-bae7-fe9cba14d0d1", "clusters" : [ "*" ], "accessScope" : { "namespaces" : [ "*" ] }, "policy" : "CCEAdminPolicy", "principal" : { "type" : "user", "ids" : [ "069fcc2116c347b89869eae3cdxxxxxx1", "069fcc2116c347b89869eae3cdxxxxxx2" ] }, "createTime" : "", "updateTime" : "" }
状态码
状态码 |
描述 |
---|---|
201 |
错误码
请参见错误码。