# 查询自定义认证列表 - ListCustomAuthorizersV2 #### 功能介绍 查询自定义认证列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-apig/apig-api-180713003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apig/apig-api-grant-policy_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | apig:customAuthorizer:list | List | instance \* | g:ResourceTag/\ | apig:authorizers:list | apig:instance:get | #### URI GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-apig/apig-api-180713009.html)。 | | instance_id | 是 | String | 实例ID，在API网关控制台的"实例信息"中获取。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Long | 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：**0** | | limit | 否 | Integer | 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：**1** 最大值：**500** 缺省值：**20** | | id | 否 | String | 编号 | | name | 否 | String | 名称 | | type | 否 | String | 自定义认证类型。 - FRONTEND：前端 - BACKEND：后端 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | 本次返回的列表长度 | | total | Long | 满足条件的记录数 | | authorizer_list | Array of [AuthorizerResp] objects | 自定义认证列表 | 表5AuthorizerResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 自定义认证的名称。 长度为3 \~ 64位的字符串，字符串由中文、英文字母、数字、"_"组成，且只能以英文或中文开头。 | | type | String | 自定义认证类型 - FRONTEND：前端 - BACKEND：后端 不支持修改 | | authorizer_type | String | 自定义认证的类型。当前只支持函数类型：FUNC。 | | authorizer_uri | String | 函数地址。 | | network_type | String | 对接函数的网络架构类型 - V1：非VPC网络架构 - V2：VPC网络架构 缺省值：**V1** | | authorizer_version | String | 函数版本。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN 最大长度：**64** | | authorizer_alias_uri | String | 函数别名地址。 当函数别名URN和函数版本同时传入时，函数版本将被忽略，只会使用函数别名URN | | identities | Array of [Identity] objects | 认证来源 | | ttl | Integer | 缓存时间 | | user_data | String | 用户数据 | | ld_api_id | String | 自定义后端服务ID。 暂不支持 | | need_body | Boolean | 是否发送body | | id | String | 自定义认证编号 | | create_time | String | 创建时间 | | roma_app_id | String | 自定义认证所属应用编号 暂不支持 | | roma_app_name | String | 自定义认证所属应用名称 暂不支持 | 表6Identity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名称 | | location | String | 参数位置 | | validation | String | 参数校验表达式，默认为null，不做校验 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 无 #### 响应示例 **状态码：200** OK ``` { "total" : 1, "size" : 1, "authorizer_list" : [ { "name" : "Authorizer_demo", "type" : "FRONTEND", "authorizer_type" : "FUNC", "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:default:apigDemo_1592617458814", "network_type" : "V1", "authorizer_version" : "v1", "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:default:apigDemo_1592617458814:!v1", "identities" : [ { "name" : "header", "location" : "HEADER" } ], "ttl" : 0, "user_data" : "authorizer_test", "id" : "0d982c1ac3da493dae47627b6439fc5c", "create_time" : "2020-07-31T11:55:43Z" } ] } ``` **状态码：400** Bad Request ``` { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } ``` **状态码：401** Unauthorized ``` { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } ``` **状态码：403** Forbidden ``` { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } ``` **状态码：404** Not Found ``` { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" } ``` **状态码：500** Internal Server Error ``` { "error_code" : "APIG.9999", "error_msg" : "System error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-apig/ErrorCode.html)。