# 分页批量查询国家/地区

分页批量查询国家/地区。资源介绍请参考[概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v3/country_region/resource-definition)。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/mdm/v3/country_regions
HTTP Method | GET
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查询国家/地区的公共数据(mdm:country_region:read)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
languages | string\[\] | 是 | 希望返回的语言种类，支持格式如下：<br>- 中文：zh-CN<br>- 英文：en-US<br>- 日文：ja-JP<br>对于多语文本字段，传入特定语言，将会返回对应语言文本<br>**示例值**：en-US<br>**数据校验规则**：<br>- 长度范围：`0` ～ `100`
fields | string\[\] | 是 | 需要的查询字段集<br>**示例值**：name<br>**数据校验规则**：<br>- 长度范围：`1` ～ `100`
limit | int | 否 | 查询页大小<br>**示例值**：10<br>**数据校验规则**：<br>- 取值范围：`1` ～ `1000`
offset | int | 否 | 查询起始位置<br>**示例值**：0<br>**数据校验规则**：<br>- 取值范围：`0` ～ `100000`
return_count | boolean | 否 | 是否返回总数<br>**示例值**：true
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
filter | filter | 否 | 过滤参数
logic | string | 是 | 逻辑关系<br>同一层级的多个expression由logic参数决定使用“与/或”条件<br>0=and，1=or<br>**示例值**："0"
expressions | expression\[\] | 否 | 过滤条件<br>**数据校验规则**：<br>- 长度范围：`0` ～ `100`
field | string | 是 | 字段名<br>**示例值**："name"
operator | string | 是 | 运算符。<br>0=等于，1=不等于，2=大于，3=大于等于，4=小于，5=小于等于，6=属于任意，7=不属于任意，8=匹配，9=前缀匹配，10=后缀匹配，11=为空，12=不为空<br>**示例值**："0"
value | value | 是 | 字段值
string_value | string | 否 | 字符串值<br>**示例值**："安道尔"
bool_value | boolean | 否 | 布尔值<br>**示例值**：true
int_value | string | 否 | 整型值<br>**示例值**："111"
string_list_value | string\[\] | 否 | 字符串列表值<br>**示例值**：["1"]
int_list_value | string\[\] | 否 | 整型列表值<br>**示例值**：["1"]
common | common | 否 | 此参数可忽略

### 请求体示例
```json
{
    "filter": {
        "logic": "0",
        "expressions": [
            {
                "field": "name",
                "operator": "0",
                "value": {
                    "string_value": "安道尔",
                    "bool_value": true,
                    "int_value": "111",
                    "string_list_value": [
                        "1"
                    ],
                    "int_list_value": [
                        "1"
                    ]
                }
            }
        ]
    },
    "common": {}
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
data | country_region\[\] | 国家/地区目录列表
alpha_3_code | string | 三位字母代码。与ISO国家代码的三位代码一致。
alpha_2_code | string | 两位字母代码。与ISO国家代码的二位代码一致。
numeric_code | string | 数字代码。与ISO国家代码的Numeric代码一致
name | i18n_string | 国家/地区名称
value | string | 入参languages中排序第一的语言对应的值。
multilingual_value | map&lt;string, string&gt; | 入参languages中所有语言对应的值。
return_language | string | value实际返回的值对应的语言，如"zh-CN"
mdm_code | string | 主数据编码（系统生成的唯一永久代码，格式为“MDCT+8位数字”）
full_name | i18n_string | 国家/地区全称
value | string | 入参languages中排序第一的语言对应的值。
multilingual_value | map&lt;string, string&gt; | 入参languages中所有语言对应的值。
return_language | string | value实际返回的值对应的语言，如"zh-CN"
global_code | string | 国际电话区号
status | string | 是否生效。0代表否，1代表是
continents | enum | 所属大洲。可选值如下<br>1-亚洲，2-欧洲，3-非洲，4-北美洲，5-南美洲，6-大洋洲，7-南极洲）
value | string | 入参languages中排序第一的语言对应的值。
multilingual_name | map&lt;string, string&gt; | 入参languages中所有语言对应的值。
total | string | 总数
next_page_token | string | 下一次分页参数

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "alpha_3_code": "AND",
                "alpha_2_code": "AD",
                "numeric_code": "20",
                "name": {
                    "value": "安道尔",
                    "multilingual_value": {
                        "zh-CN": "安道尔"
                    },
                    "return_language": "zh-CN"
                },
                "mdm_code": "MDCT00000001",
                "full_name": {
                    "value": "安道尔公国",
                    "multilingual_value": {
                        "zh-CN": "安道尔公国"
                    },
                    "return_language": "zh-CN"
                },
                "global_code": "+376",
                "status": "1",
                "continents": {
                    "value": "2",
                    "multilingual_name": {
                        "zh-CN": "安道尔"
                    }
                }
            }
        ],
        "total": "0",
        "next_page_token": "token"
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1640201 | invalid params | 参数非法，请检查参数
400 | 1640202 | param not found | 参数为空，请检查参数填写是否完整
400 | 1640203 | object field not found | 此字段不在查询范围内，请检查
400 | 1640204 | language is invalid | 非法语言，请重新填写
400 | 1640205 | params is required | 必填参数未填写，请检查
400 | 1640206 | limit too large | 查询数量过大，请限制在1000以内
400 | 1640207 | limit plus offset too large | 查询数量和起始位置加和过大，请限制在10000以内
400 | 1640208 | page token invalid | 分页码无效，请检查该参数
400 | 1640209 | record id not found | 未发现符合条件行级记录，请检查查询参数
400 | 1640210 | sort by null is not allowed | 排序参数填写有误，请检查
400 | 1640211 | biz codes is empty | 业务编码为空，请检查
400 | 1640212 | mdm codes is empty | 主数据编码为空，请检查
400 | 1640213 | biz id is invalid | 业务编码非法，请检查
500 | 1640101 | system error | 系统错误，联系飞书技术支持排查
500 | 1640102 | invalid generic method | 请求方法错误，联系飞书技术支持排查
500 | 1640103 | call meta service error | 请求元数据方法错误，联系飞书技术支持排查
500 | 1640104 | meta data not found | 找不到对应元数据，联系飞书技术支持排查
500 | 1640105 | data source request invalid | 数据库请求非法，联系飞书技术支持排查
500 | 1640106 | db error | 数据库错误，联系飞书技术支持排查
500 | 1640107 | func not supported yet | 服务不支持该方法，联系飞书技术支持排查
500 | 1640108 | field type not supported yet | 字段类型不支持，联系飞书技术支持排查
500 | 1640109 | validator not found | 未发现数据校验规则，联系飞书技术支持排查
500 | 1640110 | transformer not found | 未发现数据转换规则，联系飞书技术支持排查
500 | 1640111 | executor not found | 未发现执行器，联系飞书技术支持排查
500 | 1640112 | invalid data source type | 错误数据库类型，联系飞书技术支持排查
500 | 1640113 | data source not found | 未发现数据库，联系飞书技术支持排查
500 | 1640114 | data source invalid | 数据库无效，联系飞书技术支持排查
500 | 1640115 | meta setting not found | 未发现元数据配置，联系飞书技术支持排查
500 | 1640116 | generate page token error | 分页码生成错误，联系飞书技术支持排查
500 | 1640117 | record duplicate error | 行级记录重复，联系飞书技术支持排查
500 | 1640118 | generate idl error | idl生成错误，联系飞书技术支持排查
500 | 1640119 | producer not found error | 消息生产者错误，联系飞书技术支持排查
500 | 1640120 | custom func request error | 自定义执行器请求错误，联系飞书技术支持排查
500 | 1640121 | custom func response error | 自定义执行器响应错误，联系飞书技术支持排查

