返回空间下区域节点(分页 + 关键字过滤),前端按 ParentID 构建区域树
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListHikCloudAreas | 要执行的操作,取值:ListHikCloudAreas。 |
Version | String | 是 | 2026-07-01 | API的版本,取值:2026-07-01。 |
SpaceID | String | 是 | 8b629168-70bf-42be-ae15-7d259006bd9e | 空间 ID |
Keyword | String | 否 | 北京 | area_name 模糊匹配 |
PageNumber | Integer | 否 | 1 | 页码,默认 1 |
PageSize | Integer | 否 | 100 | 每页条数,默认 20,最大 500 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Total | Long | 1000 | 门店总数 |
PageNumber | Integer | 1 | 当前页码 |
PageSize | Integer | 20 | 每页条数 |
Areas | Array of Object | [ | 区域列表 |
GET /?Action=ListHikCloudAreas&Version=2026-07-01&SpaceID=8b629168-70bf-42be-ae15-7d259006bd9e&Keyword=北京&PageNumber=1&PageSize=100 HTTP/1.1 Host: open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20260711T120000Z X-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 Authorization: HMAC-SHA256 Credential=AKLT********/20260711/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=****************************************
{ "ResponseMetadata": { "RequestId": "2026071120000000000000000000000000", "Action": "ListHikCloudAreas", "Version": "2026-07-01", "Service": "aiotvideo", "Region": "cn-beijing", "Error": null }, "Result": { "Total": 12, "PageNumber": 1, "PageSize": 100, "Areas": [ { "SpaceID": "...", "AreaID": "1001", "AreaName": "区域2", "ParentID": "1000", "PathName": "/区域1/区域2/" } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
401 | hik_credential_invalid | ClientID/ClientSecret 无效或 token 获取失败 |
401 | credential_invalid | 鉴权信息已失效,请重新验证凭证 |
403 | forbidden | 空间不属于当前 AccountID |
403 | hik_no_permission | 无数据操作权限 |
500 | hik_cloud_not_configured | 服务未配置 master_key 或 TOS |