# 查询接入策略 - ListAccessPolicies #### 功能介绍 该接口用于查询接入策略。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ListAccessPolicies)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:accessPolicies:get | Read | - | - | - | - | #### URI GET /v2/{project_id}/access-policy 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | access_control_type | 否 | String | 接入策略控制类型 - ACCESS_TYPE： 接入类型 - IP_WHITE_LIST： IP白名单 | | limit | 否 | Integer | 每页数量,范围0-100,默认100。 | | offset | 否 | Integer | 偏移量,范围0-99,默认0。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policies | Array of [AccessPolicyDetailInfo] objects | 查询接入策略响应。 | | total | Integer | 策略总数。 | 表4AccessPolicyDetailInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_name | String | 策略名。 | | blacklist_type | String | 黑名单类型，当前黑名单只支持互联网。 - INTERNET： 互联网 | | access_control_type | String | 访问控制类型。默认为接入类型 - ACCESS_TYPE： 接入类型 - IP_WHITE_LIST： IP白名单 | | ip_list | Array of [IpInfo] objects | 策略的ip列表。 | | is_enable | Boolean | IP白名单是否生效。只能单独更新，此值的优先级最高，传此值只修改该策略是否生效。 | | is_block_all | Boolean | IP白名单是否禁止所有Ip接入。is_enable为false时，无法修改此值。此值也只能单独更新。 | | ip_total_count | Integer | 策略总数。 | | policy_id | String | 策略id。 | | create_time | String | 接入策略创建的时间。 | 表5IpInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip_address | String | ip地址。 | | subnet_mask | String | 子网掩码。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：405** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：503** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` get /v2/{project_id}/access-policy ``` #### 响应示例 **状态码：200** 正常。 ``` { "policies" : [ { "policy_id" : "8ac225c2781edb0d01781edde3f4xxxx", "create_time" : "2022-10-24T17:24:56.000+00:00", "policy_name" : "PRIVATE_ACCESS", "blacklist_type" : "INTERNET" } ], "total" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 正常。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 405 | 请求中指定的方法不被允许。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | | 503 | 服务不可用。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。