链接复制成功！
创建Role
功能介绍
创建Role。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/instances/{instance_id}/roles
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
|
instance_id |
是 |
String |
LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
Array of strings |
租户token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
role_name |
是 |
String |
角色名称。只能包含字母、数字、下划线，且长度为1到49个字符。 |
|
description |
否 |
String |
描述信息。最大长度为4000个字符。 |
|
parameters |
否 |
Map<String,String> |
参数。 |
|
external_role_id |
否 |
String |
用户端角色id，创建时指定，不可修改。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
role_name |
String |
角色名称。只能包含字母、数字、下划线，且长度为1到49个字符。 |
|
description |
String |
描述信息。最大长度为4000个字符。当无描述信息时，则description值为null，当值为null时，响应Body无该参数。 |
|
principal_source |
String |
主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 |
|
parameters |
Map<String,String> |
参数。 |
|
external_role_id |
String |
用户端角色id，创建时指定，不可修改。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
错误信息。 |
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
title |
String |
标题。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
title |
String |
标题。 |
|
message |
String |
错误信息。 |
|
code |
String |
状态码。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：408
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
请求示例
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/roles
{
"role_name" : "admin",
"description" : "role from lakeformation"
}响应示例
状态码：201
Created
{
"role_name" : "admin",
"principal_source" : " LOCAL ",
"description" : "role from lakeformation"
}状态码：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"
}状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
408 |
Request Timeout |
|
500 |
Internal Server Error |
错误码
请参见错误码。
