文档首页 > > API参考> API> 凭证管理> 创建GB28181凭证

创建GB28181凭证

分享
更新时间:2020/09/21 GMT+08:00

功能介绍

该接口用于创建GB28181凭证,该凭证用于GB28181设备注册时使用。

URI

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

    参数

    是否必选

    类型

    说明

    project_id

    String

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

请求消息

  • 请求样例
    POST /v1/{project_id}/credentials/codes
    {
        "username" : "userJack",
        "password" : "hexxxxx3",
        "type" : "NORMAL",
        "description" : "this is for device."
    }
  • 参数说明

    参数

    是否必选

    类型

    说明

    username

    String

    凭证用户名,全局唯一。

    • 当type为NORMAL(非匿名)时,该参数必选。
    • 当type为ANONYMOUS(匿名)时,该参数被忽略。

    长度为1~32,可以包含字母、数字,不能包含其他的特殊字符。

    type

    String

    凭证类型,可选值为:

    • NORMAL:非匿名,表示当使用该凭证作为设备凭证时,使用凭证指定的username作为用户名。
    • ANONYMOUS:匿名,表示当使用该凭证作为设备凭证时,使用设备的ID作为用户名。

    不区分大小写,该参数默认值为“NORMAL”

    password

    String

    凭证密码。长度为8位~32位的字符串,至少包含以下三种字符:大写字母、小写字母、数字和特殊字符(@#_-*)。

    密码不能与凭证用户名相同,也不能与用户名的倒序相同。

    description

    String

    凭证描述,长度不超过500个字符。

响应消息

  • 响应样例
    {
        "created_at": "2018-10-25T11:45:01Z",
        "description": "this is for device.",
        "username": "userJack",
        "type" : "normal",
        "updated_at": "2018-10-25T11:45:01Z"
    }
  • 参数说明

    参数

    类型

    说明

    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

提交反馈 取消

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

智能客服提问云社区提问