查询区域列表
最近更新时间：2026-03-19 18:16:28
天翼云智能视图服务API
1. 查询区域列表
接口功能介绍
本接口用于查询区域列表。
接口约束
无
URI
GET /regions
路径参数
无
Query参数
无
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Provinces | Array of Objects | 省份列表。 | Province | |
| SpecialZones | Array of Objects | 专区列表。 | SpecialZone | |
| RequestId | String | 请求ID。 | ba41650f6da84a20bc386c87285cebe6 |
表 Province
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Name | String | 省份名称。 | 贵州 | |
| Citys | Array of Objects | 城市列表。 | City |
表 City
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Name | String | 城市名称。 | 贵阳 | |
| Regions | Array of Objects | 区域列表。 | Region |
表 Region
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| RegionId | String | 区域ID。 | 0851001 | |
| RegionName | String | 区域名称。 | 贵阳1 |
表 SpecialZone
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ZoneId | String | 专区ID。 | 2 | |
| ZoneName | String | 专区名称。 | 物联网接入专区 | |
| Regions | Array of Objects | 区域列表。 | Region |
请求示例
请求url
GET '/regions'
请求头header
{
"Authorization": "CT-HMAC-SHA256 Credential=AVVG8XLD7V1IRZNLGXWM/2023-04-03/vss, SignedHeaders=content-type;host;timestamp, Signature=4674301fa14990d864988f941cd42851806d63f7585b00c48cde22c9ad0be2de",
"Content-Type": "application/json;charset=utf-8",
"Host": "127.0.0.1",
"Version": "2021-11-25",
"Timestamp": "1680515523"
}
请求体body
无
响应示例
{
"statusCode": 200,
"message": "请求成功",
"requestId": "ba41650f6da84a20bc386c87285cebe6",
"returnObj": {
"Provinces": [
{
"Name": "贵州",
"Citys": [
{
"Name": "贵阳",
"Regions": [
{
"RegionId": "0851001",
"RegionName": "贵阳1"
},
{
"RegionId": "0859999",
"RegionName": "贵阳-信令重构"
}
]
}
]
}
],
"SpecialZones": [
{
"ZoneId": "2",
"ZoneName": "物联网接入专区",
"Regions": [
{
"RegionId": "0851001",
"RegionName": "专区1"
}
]
}
],
"RequestId": "ba41650f6da84a20bc386c87285cebe6"
}
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。
本页目录：