客户运营能力客户运营能力

更新时间:2021/06/24 GMT+08:00
分享

查询省份信息

功能介绍

客户在自建平台上查询省份信息。

接口约束

该接口可以使用客户AK/SK或者Token调用。

调试

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

URI

GET /v2/systems/configs/provinces

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

最大长度:8

语言。

  • zh_CN:中文
  • en_us:英文

缺省为zh_CN。

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

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/provinces HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

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

error_msg

String

最大长度:1000

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

count

Integer

最大长度:1000

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

provinces

List<Province>

-

省份信息列表,成功的时候返回,具体参见表3

表3 Province

参数

参数类型

取值范围

描述

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": 31,
    "provinces": [
        {
            "code": "CN-11",
            "name": "北京市"
        },
        {
            "code": "CN-12",
            "name": "天津市"
        },
        {
            "code": "CN-13",
            "name": "河北省"
        },
        {
            "code": "CN-14",
            "name": "山西省"
        },
        {
            "code": "CN-15",
            "name": "内蒙古自治区"
        },
        {
            "code": "CN-21",
            "name": "辽宁省"
        },
        {
            "code": "CN-22",
            "name": "吉林省"
        },
        {
            "code": "CN-23",
            "name": "黑龙江省"
        },
        {
            "code": "CN-31",
            "name": "上海市"
        },
        {
            "code": "CN-32",
            "name": "江苏省"
        }
    ]
}

状态码

HTTP状态码

错误码

错误描述

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品