文档首页 > > API参考> API> 凭证管理> 获取GB28181凭证列表

获取GB28181凭证列表

分享
更新时间: 2019/09/03 16:30

功能介绍

该接口用于获取所有GB28181凭证。

URI

  • URI格式
    GET /v1/{project_id}/credentials/codes
  • 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目ID,获取方法请参见获取项目ID

请求

  • 请求样例
    GET /v1/6204a5bd270343b5885144cf9c8c158d/credentials/codes
  • 查询参数说明

    参数

    是否必选

    类型

    说明

    offset

    Integer

    查询的开始位置,取值范围为1~100000,必须与limit一起使用。

    与limit同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。

    如果offset超过数据总条数,则结果返回空列表。

    limit

    Integer

    返回结果的最大条目数,取值范围为1~1000,必须与offset一起使用。

    与offset同时缺省时,返回所有结果。该参数适用于所有查询列表的接口。

    sort

    String

    返回结果的排序规则:
    • ASC:表示升序。
    • DESC:表示降序。

    默认为ASC,需要有offset和limit参数,sort参数才会生效。

    order_by

    Integer

    选择按一个字段排序,可选值为:
    • username
    • created_at
    • updated_at

    默认为created_at,按照创建时间排序。需要有offset和limit参数,order_by参数才会生效。

    username

    String

    根据凭证用户名过滤,支持模糊搜索。

    type

    String

    根据凭证类型过滤,可选值为:

    • NORMAL
    • ANONYMOUS

    不区分大小写。

响应

  • 响应样例
    [{
        "username" : "userJack",
        "description" : " this is for device.",
        "created_at" : "2018-10-12T03:38:24Z",
        "type" : "normal",
        "updated_at" : "2018-10-12T03:38:24Z"
    }]
  • 参数说明

    参数

    类型

    说明

    username

    String

    凭证用户名。

    description

    String

    凭证描述。

    type

    String

    凭证类型。

    created_at

    String

    凭证创建时间。

    updated_at

    String

    凭证更新时间。

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。具体返回错误码请参考错误码说明

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源或没有开通服务。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区