文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 环境权限管理/ 编辑环境权限
更新时间：2024-06-28 GMT+08:00
在线调试
CLI示例
查看PDF

编辑环境权限

功能介绍

编辑环境权限。

调用方法

请参见如何调用API。

URI

PUT /v2/applications/{application_id}/environments/{environment_id}/permissions

表1 路径参数

参数

是否必选

参数类型

描述

application_id

是

String

应用id

最小长度：32

最大长度：32

environment_id

是

String

环境id

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json

缺省值：application/json;charset=utf-8

枚举值：

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

最小长度：0

最大长度：20000
表3 请求Body参数

参数

是否必选

参数类型

描述

role_id

否

String

角色id

最小长度：0

最大长度：40

permission_name

否

String

权限名称，can_view：查看权限；can_edit：编辑权限；can_delete：删除权限；can_deploy：部署权限；can_manage：权限管理权限

最小长度：0

最大长度：32

枚举值：

  • can_view

  • can_edit

  • can_delete

  • can_deploy

  • can_manage

permission_value

否

Boolean

true 有权限，false 无权限

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

最小长度：0

最大长度：64

result

DevUcEnvironmentPermission object

更新后的环境权限信息
表5 DevUcEnvironmentPermission

参数

参数类型

描述

id

Integer

权限id

role_id

String

角色id

最小长度：1

最大长度：40

devuc_role_id_list

Array of strings

角色id列表

最小长度：32

最大长度：32

role_type

String

角色类型， environment-creator： 环境创建者； project： 项目管理员；template-customized-inst：系统角色； template-project-customized、project-customized：自定义角色

枚举值：

  • environment-creator

  • project

  • template-customized-inst

  • template-project-customized

  • project-customized

name

String

角色名称

最小长度：0

最大长度：255

region

String

局点信息

environment_id

String

环境id

最小长度：0

最大长度：32

can_view

Boolean

是否有查看权限

can_edit

Boolean

是否有编辑权限

can_delete

Boolean

是否有删除权限

can_deploy

Boolean

是否有部署权限

can_manage

Boolean

是否有权限管理权限

create_time

String

创建时间

update_time

String

修改时间

请求示例

https://{endpoint}/v2/applications/8ddf0566c1784da29faac80516fa8425/environments/54e5b8b0d10148cc96142ac9d6c1c1f6/permissions

{
  "permission_name" : "can_deploy",
  "permission_value" : true,
  "role_id" : "e72b8cebe2c6499db2b23276b3820736"
}

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "region" : "region",
    "id" : null,
    "name" : null,
    "role_id" : "0",
    "devuc_role_id_list" : null,
    "environment_id" : "be3e9690d6f64b23b54e79cd02c4b156",
    "can_view" : true,
    "can_edit" : true,
    "can_delete" : true,
    "can_deploy" : true,
    "can_manage" : true,
    "create_time" : null,
    "update_time" : null,
    "role_type" : "environment-creator"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 环境权限管理