查询自定义鉴权列表
功能介绍
应用服务器可调用此接口在物联网平台查询自定义鉴权列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v5/iot/{project_id}/device-authorizers
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
authorizer_name |
否 |
String |
参数说明：自定义鉴权名称，同一租户下的自定义鉴权器名称不能重复。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
limit |
否 |
Integer |
参数说明：分页查询时每页显示的记录数。 取值范围：1-50的整数，默认值为10。 最小值：1 最大值：50 缺省值：10 |
marker |
否 |
String |
参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 取值范围：长度为24的十六进制字符串，默认值为ffffffffffffffffffffffff。 缺省值：ffffffffffffffffffffffff |
offset |
否 |
Integer |
参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数，默认为0。 最小值：0 最大值：500 缺省值：0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
authorizers |
Array of DeviceAuthorizerSimple objects |
参数说明：自定义鉴权列表。 |
page |
Page object |
查询结果的分页信息。 |
参数 |
参数类型 |
描述 |
|---|---|---|
authorizer_id |
String |
参数说明：自定义鉴权ID。 |
authorizer_name |
String |
参数说明：自定义鉴权器名称，同一租户下的自定义鉴权器名称不能重复。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
func_name |
String |
参数说明：自定义鉴权器对应的函数名称。 |
func_urn |
String |
参数说明：函数的URN（Uniform Resource Name），唯一标识函数，即自定义鉴权器对应的处理函数地址。 |
signing_enable |
Boolean |
参数说明：是否启动签名校验，启动签名校验后不满足签名要求的鉴权信息将被拒绝，以减少无效的函数调用。推荐用户进行安全的签名校验，默认开启。 缺省值：true |
default_authorizer |
Boolean |
参数说明：当前自定义鉴权是否为默认的鉴权方式，默认为false，当设置为true时，用户所有支持SNI的设备，如果在鉴权时不指定使用特定的设备鉴权，将统一使用当前鉴权器策略进行鉴权。 缺省值：false |
status |
String |
参数说明：是否激活该鉴权方式
缺省值：INACTIVE |
cache_enable |
Boolean |
参数说明：是否开启缓存，默认为false，设备为true时，当设备入参（username，clientId，password，以及证书信息，函数urn）不变时，当缓存结果存在时，将直接使用缓存结果，建议在调试时设置为false，生产时设置为true，避免频繁调用函数。 缺省值：false |
create_time |
String |
在物联网平台查询自定义鉴权的时间。格式：yyyyMMdd'T'HHmmss'Z'，如：20151212T121212Z。 |
update_time |
String |
在物联网平台更新查询自定义鉴权的时间。格式：yyyyMMdd'T'HHmmss'Z'，如：20151212T121212Z。 |
请求示例
查询租户下的自定义鉴权列表
GET https://{endpoint}/v5/iot/{project_id}/device-authorizers
响应示例
状态码： 200
OK
{
"authorizers" : [ {
"authorizer_id" : "5c90fa7d3c4e4405e8525079",
"authorizer_name" : "myTest",
"func_name" : "mqtt_auth",
"func_urn" : "urn:fss:cn-north-5:d92d9c5eb8e347b5bb31ecfe5bc0c4e1:function:default:mqtt_auth:lates",
"signing_enable" : true,
"default_authorizer" : false,
"status" : "ACTIVE",
"cache_enable" : false,
"create_time" : "20231031T070547Z",
"update_time" : "20231031T070547Z"
} ],
"page" : {
"count" : 1,
"marker" : "5c90fa7d3c4e4405e8525079"
}
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
