文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 角色管理/ 修改角色信息
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

修改角色信息

功能介绍

修改角色信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/instances/{instance_id}/roles/{role_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

role_name

是

String

角色名称。只能包含字母、数字、下划线、中划线，且长度为1~255个字符。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

描述信息。最大长度为4000个字符。

role_name

是

String

角色名称。只能包含字母、数字、下划线、中划线，且长度为1~255个字符。

parameters

否

Map<String,String>

参数。

external_role_id

否

String

用户端角色id，创建时指定，不可修改。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

role_name

String

角色名称。只能包含字母、数字、下划线、中划线，且长度为1~255个字符。

description

String

描述信息。最大长度为4000个字符。当无描述信息时，则description值为null，当值为null时，响应Body无该参数。

principal_source

String

主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。

枚举值：

  • IAM

  • SAML

  • LDAP

  • LOCAL

  • AGENTTENANT

  • OTHER

parameters

Map<String,String>

参数。

external_role_id

String

用户端角色id，创建时指定，不可修改。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/roles/{role_name}

{
  "description" : "test description",
  "role_name" : "admin"
}

响应示例

状态码： 200

OK

{
  "role_name" : "admin",
  "description" : "string",
  "principal_source" : "LOCAL"
}

状态码： 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码： 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

状态码： 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码： 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码： 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码： 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 角色管理