更新时间:2022-05-24 GMT+08:00
分享

查询城市信息

功能介绍

伙伴在伙伴销售平台上查询城市信息。

接口约束

该接口可以使用合作伙伴AK/SK或者Token调用。

调试

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

URI

GET /v2/systems/configs/cities

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

最大长度:8

语言。

  • zh_CN:中文
  • en_us:英文

缺省为zh_CN。

查询参数

参数

是否必选

参数类型

取值范围

描述

province_code

String

最大长度:40

省份编码。

offset

Integer

[0-最大整数]

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

说明:

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

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

limit

Integer

最大长度:1000

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

请求消息

请求参数

请求示例

GET https://bss.myhuaweicloud.com/v2/systems/configs/cities?province_code=CN-13 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。具体请参考状态码。只有失败才返回该字段。

error_msg

String

最大长度:1000

错误描述信息。只有失败才返回该字段。

count

Integer

最大长度:1000

查询个数,成功的时候返回。

cities

List<City>

-

城市信息列表,成功的时候返回,具体参见表2

表2 City

参数

参数类型

取值范围

描述

code

String

最大长度:40

城市的编码。

name

String

最大长度:100

城市的名称,根据请求参数X-Language的取值返回对应语言的名称,目前仅支持中文。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time 
{
    "count": 12,
    "cities": [
        {
            "code": "CN-13-006",
            "name": "保定市"
        },
        {
            "code": "CN-13-009",
            "name": "沧州市"
        },
        {
            "code": "CN-13-008",
            "name": "承德市"
        },
        {
            "code": "CN-13-004",
            "name": "邯郸市"
        },
        {
            "code": "CN-13-011",
            "name": "衡水市"
        },
        {
            "code": "CN-13-010",
            "name": "廊坊市"
        },
        {
            "code": "CN-13-003",
            "name": "秦皇岛市"
        },
        {
            "code": "CN-13-001",
            "name": "石家庄市"
        },
        {
            "code": "CN-13-002",
            "name": "唐山市"
        },
        {
            "code": "CN-13-005",
            "name": "邢台市"
        }
    ]
}

状态码

  • 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
  • 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。

HTTP状态码

错误码

错误描述

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品

close