行政区划查询接口--内容洞察平台-火山引擎

文档中心

立即注册

导航

行政区划查询接口

最近更新时间：2024.07.11 14:18:25首次发布时间：2024.01.11 10:56:25

本文档介绍内容洞察行政区划查询接口的调用方式。

概述

为了消除不同地区存在不同行政区划名称的问题，内容洞察提供了符合内容洞察标准的位置检索接口，用户可查询各国可支持订阅的有效地名及对应区划层级，接口支持对地点的行政区划等级采用「精准」和「模糊」两种匹配模式：

【默认】精准匹配： 位置的行政区划等级严格等于输入key值，如province="海南"只能匹配到[province="海南省"]，不包括[province="青海省", city="海南州"]；
模糊匹配： 不校验行政区划等级，只保证行政区划等级更高的位置能包含等级更低的位置，如[region="日本", city="Tokyo"]能匹配到[region="日本国", province="东京都"]

注意

创建/修改订阅规则时，对位置规则的校验采用精准匹配模式

如匹配不到有效位置则会报错，不支持此次变更。
如匹配到多个有效位置取“或”关系创建规则。

请求接口

基本信息

名称	内容
接口地址	/openapi/biz_sub/search_location
请求方式	POST
是否需要鉴权	是
QPS限制	5

请求参数

Header请求参数

字段	类型	是否必填	说明
X-Insight-Biz-Name	string	是	业务名称，见「数据流管理」-API配置-「账号ID」
X-Insight-Access-Token	string	是	访问凭证，获取方式调用指南
Content-Type	string	是	'application/json'

Body请求参数

字段		类型	是否必填	说明
based_location	region	string	based_location必填，region/province/city/district/town任选，至少包含一项	国家/地区
	province	string		国家/地区以下第一级行政区划，如省、直辖市、State(US)、都、道、府、县(JP)等
	city	string		国家/地区以下第二级行政区划，如市、自治县、County(US)、町、村(JP)等
	district	string		国家/地区以下第三级行政区划，如区、县、City(US)等
	town	string		国家/地区以下第四级行政区划，如乡、镇、街道等
is_fuzzy		bool	默认为false	是否开启层级模糊匹配

返回参数

字段		类型	说明
status		int	0为成功
message		string	返回错误信息
data	region	string	based_location必填，region/province/city/district/town任选，至少包含一项	国家/地区
	province	string		国家/地区以下第一级行政区划，如省、直辖市、State(US)、都、道、府、县(JP)等
	city	string		国家/地区以下第二级行政区划，如市、自治县、County(US)、町、村(JP)等
	district	string		国家/地区以下第三级行政区划，如区、县、City(US)等
	town	string		国家/地区以下第四级行政区划，如乡、镇、街道等

调用示例

请求示例

POST /openapi/biz_sub/search_location

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token
Content-Type: application/json

body:
{
    "based_location": {
        "region":"中国","district":"白云"
    },
    "is_fuzzy": true // 是否模糊匹配
}

返回示例

{
    "status": 0,
    "message": "succeed",
    "data": [
        // 推荐使用一下完整结果作为位置订阅的配置入参
        {
            "region": "中华人民共和国",
            "province": "广东省",
            "city": "广州市",
            "district": "白云区"
        }, 
        {
            "region": "中华人民共和国",
            "province": "贵州省",
            "city": "贵阳市",
            "district": "白云区"
        },
        {
            "region": "中华人民共和国",
            "province": "河北省",
            "city": "保定市",
            "district": "顺平县",
            "town": "白云乡"
        }
    ]
}