
# 查询省份信息-ListProvinces
#### 功能介绍
伙伴在伙伴销售平台上查询省份信息。
#### 接口约束
该接口可以使用解决方案提供商或华为云总经销商（一级经销商）的AK/SK或者Token调用。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=BSS&api=ListProvinces)中调试该接口。
#### 授权信息
伙伴操作员账号调用当前API无需授权。
#### URI
GET /v2/systems/configs/provinces
表1查询参数 
| 参数     | 是否必选 | 参数类型    | 取值范围       | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|:---|
| 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/provinces HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
```
#### 响应消息
**响应参数**
| 参数         | 参数类型             | 取值范围      | 描述                                                            |
|:---|:---|:---|:---|
| error_code | String           | 最大长度：20   | 状态码。具体请参考[状态码]。只有失败才返回该字段。 |
| error_msg  | String           | 最大长度：1000 | 错误描述信息。只有失败才返回该字段。                                            |
| count      | Integer          | 最大长度：1000 | 查询个数，成功的时候返回。                                                 |
| provinces  | List\<Province\> | -         | 省份信息列表，成功的时候返回，具体参见[表2]。      |
   
 表2Province 
| 参数   | 参数类型   | 取值范围     | 描述                                 |
|:---|:---|:---|:---|
| 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": "江苏省"
        }
    ]
}
```
 #### 状态码
![](https://support.huaweicloud.com/api-bpconsole/public_sys-resources/note_3.0-zh-cn.png)
- 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
- 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。
 
| HTTP状态码 | 错误码      | 错误描述  |
|:---|:---|:---|
| 400     | CBC.0100 | 参数错误。 |
| 403     | CBC.0151 | 访问拒绝。 |
| 500     | CBC.0999 | 其他错误。 |
   
