获取GB/T28181凭证列表
功能介绍
该接口用于获取所有GB/T28181凭证。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/credentials/codes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
查询的开始位置，取值范围为1～100000，必须与limit一起使用。与limit同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。如果offset超过数据总条数，则结果返回空列表。 |
|
limit |
否 |
Integer |
返回结果的最大条目数，取值范围为1～1000，必须与offset一起使用。与offset同时缺省时，返回所有结果。该参数适用于所有查询列表的接口。 |
|
sort |
否 |
String |
返回结果的排序规则。
默认为ASC，需要有offset和limit参数，sort参数才会生效。" |
|
order_by |
否 |
String |
排序的字段，取值范围。
默认值为created_at，即按照创建时间排序。需要配置offset和limit参数，order_by参数才会生效。 |
|
username |
否 |
String |
根据凭证用户名过滤，支持模糊搜索。 |
|
type |
否 |
String |
根据凭证类型过滤，可选值如下。
不区分大小写。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
普通租户的token。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
username |
String |
凭证用户名。 |
|
description |
String |
凭证描述。 |
|
type |
String |
凭证类型。 |
|
created_at |
String |
凭证创建时间。 |
|
updated_at |
String |
凭证更新时间。 |
请求示例
GET /v1/3266392d188c47d09948b1**********/credentials/codes
响应示例
状态码： 200
正常
[ {
"username" : "0000",
"type" : "normal",
"description" : "this is for device",
"created_at" : "2018-10-12T03:38:24Z",
"updated_at" : "2018-10-12T03:38:24Z"
} ]
状态码： 400
请求错误。具体返回错误码请参考错误码说明
{
"error_msg" : "Invalid request parameter, offset should be in range [0, 100000].",
"error_code" : "VIS.0005"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常 |
|
400 |
请求错误。具体返回错误码请参考错误码说明 |
