查询角色下的用户/用户组
功能介绍
查询角色下的用户/用户组。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/instances/{instance_id}/roles/{role_name}/principals
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
instance_id |
是 |
String |
LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 |
role_name |
是 |
String |
角色名称。只能包含字母、数字、下划线、中划线，且长度为1~255个字符。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
principal_pattern |
否 |
String |
模糊匹配主体名称。只能包含中文、字母、数字和_|*.-特殊字符，且长度为1~49个字符。 |
limit |
否 |
Integer |
查询返回条数。默认值为100。最小值为1，最大值为1000。 |
marker |
否 |
String |
查询的起始记录ID。最小长度为0，最大长度为1024。 |
reverse_page |
否 |
Boolean |
是否查询上一页。默认为false。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
Array of strings |
租户token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
principal_type |
String |
主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。 枚举值：
|
principal_source |
String |
主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 枚举值：
|
principal_name |
String |
主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1~49个字符。 |
参数 |
参数类型 |
描述 |
|---|---|---|
current_count |
Integer |
本次返回的对象个数。最小值为0，最大值为2000。 |
next_marker |
String |
下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。 |
previous_marker |
String |
上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
solution_msg |
String |
解决方案描述。 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
solution_msg |
String |
解决方案描述。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
solution_msg |
String |
解决方案描述。 |
请求示例
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/roles/{role_name}/principals
响应示例
状态码： 200
OK
{
"principals" : [ {
"principal_type" : "USER",
"principal_source" : "IAM",
"principal_name" : "user1"
} ],
"page_info" : {
"current_count" : 2000,
"next_marker" : "006f492b-xxxx",
"previous_marker" : "003e6eba-xxxx"
}
}
状态码： 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 |
错误码
请参见错误码。
