查询区县信息

功能介绍

伙伴在伙伴销售平台上查询区县信息。

接口约束

该接口可以使用解决方案提供商或华为云总经销商（一级经销商）的AK/SK或者Token调用。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/systems/configs/counties

查询参数

参数	是否必选	参数类型	取值范围	描述
city_code	是	String	最大长度：20	城市的编码。
offset	否	Integer	[0-1000]	偏移量，从0开始。默认值为0。此参数不携带或携带值为空或携带值为null时，取默认值0；不支持携带值为空串。说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。示例1，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写10。
limit	否	Integer	[1-1000]	每次查询的数量，最大1000。该参数不携带时，取默认值10。该参数不支持携带值为空、不支持携带值为空串、不支持携带值为null。

参数

是否必选

参数类型

取值范围

描述

city_code

是

String

最大长度：20

城市的编码。

offset

否

Integer

[0-1000]

偏移量，从0开始。默认值为0。

此参数不携带或携带值为空或携带值为null时，取默认值0；不支持携带值为空串。

说明：

offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1，则返回满足条件的第二个数据至最后一个数据。

示例1，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。

示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写10。

limit

否

Integer

[1-1000]

每次查询的数量，最大1000。

该参数不携带时，取默认值10。

该参数不支持携带值为空、不支持携带值为空串、不支持携带值为null。

请求消息

请求参数

无

请求示例

GET https://bss.myhuaweicloud.com/v2/systems/configs/counties?city_code=CN-13-001 HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数	参数类型	取值范围	描述
error_code	String	最大长度：20	状态码。具体请参考状态码。只有失败才返回该字段。
error_msg	String	最大长度：1000	错误描述信息。只有失败才返回该字段。
count	Integer	最大长度：1000	查询个数，成功的时候返回。
counties	List<County>	-	区县信息列表，成功的时候返回，具体参见表1。

表1 County
参数	参数类型	取值范围	描述
code	String	最大长度：40	区县的编码。
name	String	最大长度：100	区县的名称，根据请求的语言会传递回对应的语言的名称，目前仅支持中文。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
    "count": 22,
    "counties": [
        {
            "code": "CN-13-001-01",
            "name": "长安区"
        },
        {
            "code": "CN-13-001-02",
            "name": "桥西区"
        },
        {
            "code": "CN-13-001-03",
            "name": "新华区"
        },
        {
            "code": "CN-13-001-04",
            "name": "裕华区"
        },
        {
            "code": "CN-13-001-05",
            "name": "藁城区"
        },
        {
            "code": "CN-13-001-06",
            "name": "鹿泉区"
        },
        {
            "code": "CN-13-001-07",
            "name": "栾城区"
        },
        {
            "code": "CN-13-001-08",
            "name": "井陉矿区"
        },
        {
            "code": "CN-13-001-09",
            "name": "辛集市"
        },
        {
            "code": "CN-13-001-10",
            "name": "晋州市"
        }
    ]
}