查询指定接入策略的应用对象 - ListAccessPolicyObjects
功能介绍
该接口用于查询指定接入策略的应用对象。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
workspace:accessPolicies:getTarget
Read
-
-
-
-
URI
GET /v2/{project_id}/access-policy/{access_policy_id}/objects
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
access_policy_id |
是 |
String |
接入策略id。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页数量,范围0-2000,默认10。 |
|
offset |
否 |
Integer |
偏移量,范围0-1999,默认0。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
policy_objects_list |
Array of AccessPolicyObject objects |
查询接入策略应用对象响应。 |
|
total |
Integer |
对象总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
object_id |
String |
黑名单中的对象id。 |
|
object_name |
String |
对象名。 |
|
object_type |
String |
对象类型。
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
get /v2/0e973a948e8091232f25c00673f168b7/access-policy/20b726affecc4411bcdc49a66e3e8f63/objects
响应示例
状态码:200
应用对象列表。
{
"policy_objects_list" : [ {
"object_id" : "8ac225c2781edb0d01781edde3f4xxxx",
"object_name" : "test1",
"object_type" : "USER"
}, {
"object_id" : "8ac225c2781edb0d01781edde3f4xxxx",
"object_name" : "test2",
"object_type" : "USER"
} ],
"total" : 2
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
应用对象列表。 |
|
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。