查询GB28181凭证列表
最近更新时间：2026-03-19 18:16:28
天翼云智能视图服务API
1.查询GB28181凭证列表
接口功能介绍
本接口用于查询GB28181凭证列表。
接口约束
无
URI
GET /gb28181Certs
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| SortBy | 否 | String | 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：CreatedTime：凭证创建时间；UpdatedTime：凭证更新时间。 | CreatedTime | |
| SortDirection | 否 | String | 排序方式，默认升序。取值：asc(升序)，desc(降序)。 | asc | |
| PageNum | 否 | Integer | 第几个分页，默认为1。 | 1 | |
| PageSize | 否 | Integer | 分页大小，默认为20。取值范围为1～1000。 | 20 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Authorization | 是 | String | 认证信息。 | CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f | |
| Content-Type | 是 | String | 互联网媒体类型。 | application/json;charset=utf-8 | |
| Host | 是 | String | 主机。 | vssapi.ctyun.cn | |
| Version | 是 | String | 版本。 | 2021-11-25 | |
| Timestamp | 是 | String | 时间戳。 | 1689643309 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码，执行成功时，不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据，执行失败时，不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| GB28181Certs | Array of Objects | 凭证列表。 | GB28181Cert | |
| PageNum | Integer | 第几个分页。 | 1 | |
| PageSize | Integer | 分页大小。 | 10 | |
| TotalPage | Integer | 分页总数。 | 1 | |
| TotalNum | Integer | 凭证总数。 | 10 | |
| RequestId | String | 请求ID。 | bed9f443d64e4361ad272860d4ab67ca |
表 GB28181Cert
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| UserName | String | 凭证用户名。 | cert | |
| UserType | String | 凭证类型。 | normal | |
| Description | String | 凭证描述。 | 描述 | |
| CreatedTime | String | 凭证创建时间。 | 20220922093159 | |
| UpdatedTime | String | 凭证更新时间。 | 20220922093159 |
请求示例
请求url
GET '/gb28181Certs?PageNum=1&PageSize=20'
请求头header
{
"Authorization": "CT-HMAC-SHA256 Credential=DS6X6E782JHKU7KHHMSH/2023-04-13/vss, SignedHeaders=content-type;host;timestamp, Signature=ef6c0c8d71cada4bcb05e9415da69373f2a1655956688dc36f2bd25d0ead0550",
"Content-Type": "application/json;charset=utf-8",
"Host": "vssapi.ctyun.cn",
"Version": "2021-11-25",
"Timestamp": "1681370792"
}
请求体body
无
响应示例
{
"statusCode": 200,
"message": "请求成功",
"requestId": "bed9f443d64e4361ad272860d4ab67ca",
"returnObj": {
"PageNum": 1,
"PageSize": 20,
"TotalPage": 1,
"TotalNum": 1,
"gb28181Certs": [
{
"UserName": "test",
"UserType": "normal",
"Description": "",
"CreatedTime": "20220922093159",
"UpdatedTime": "20221021150614"
}
],
"RequestId": "bed9f443d64e4361ad272860d4ab67ca"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录：