接口功能介绍
本接口用于创建GB28181凭证,该凭证用于GB28181设备注册。
接口约束
创建的凭证名称请勿重复。
请求参数说明:
String类型的参数,传""等同于不传。
Integer类型的参数,传0等同于不传。
Boolean类型的参数,传false等同于不传。
URI
POST /v2/gb28181Certs
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
UserName | 是 | String | 凭证用户名,长度1-64位,仅支持输入小写字母和数字。 | cert | |
Password | 是 | String | 凭证密码,凭证密码长度为8位~32位的字符串,至少包含以下三种字符:大写字母、小写字母、数字和特殊字符(@#_-*)。 | qwER1234 | |
Description | 否 | String | 凭证描述。 | cert |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应状态码。 | 200 | |
error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
message | String | 响应信息。 | 请求成功 | |
requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
returnObj | Object | 响应数据,执行失败时,不返回该字段。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
UserName | String | 凭证用户名。 | cert | |
UserType | String | 凭证类型。 | normal | |
Description | String | 凭证描述。 | 描述 | |
CreatedTime | String | 凭证创建时间。 | 1681370054428110 | |
UpdatedTime | String | 凭证更新时间。 | 1681370054428110 | |
RequestId | String | 请求ID。 | 64c9f09a7d434519abbcdd5e20620732 |
枚举参数
无
请求示例
请求url
POST '/v2/gb28181Certs'
请求头header
无
请求体body
{"UserName":"openapi01","Password":"********"}
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "64c9f09a7d434519abbcdd5e20620732","returnObj": {"UserName": "openapi01","UserType": "normal","Description": "","CreatedTime": "1681370054428110","UpdatedTime": "1681370054428110","RequestId": "64c9f09a7d434519abbcdd5e20620732"}}
状态码
请参考 状态码
错误码
请参考 错误码