淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
city_search_open_request_dto	CitySearchOpenRequestDTO	必须			根据关键字模糊匹配城市和州省列表，默认最多返回5条
└ tenant_key String 必须 ant 租户身份标识；开放API调用必填，Agent调用由上下文识别 └ limit Number 可选 5 返回数量限制，默认5 └ app_key String 必须 ant_group 调用方应用身份；开放API调用必填，Agent调用由上下文识别 └ keyword String 可选承德搜索关键字；不传时返回空列表 └ employee_no String 必须 091103 企业员工工号；开放API调用必填，Agent调用由登录态注入

名称	类型	示例值	描述
result_code	String	A00001	错误码
result_message	String	系统错误	错误信息
content	CityOpenDTO		欢行城市基础信息
└ id Number 10367 城市ID └ name String 承德城市名
is_success	Boolean	true	接口调用成功或者失败

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTaeCommonSiteSearchRequest req = new AlibabaTaeCommonSiteSearchRequest();
AlibabaTaeCommonSiteSearchRequest.CitySearchOpenRequestDTO obj1 = new AlibabaTaeCommonSiteSearchRequest.CitySearchOpenRequestDTO();
obj1.setTenantKey("ant");
obj1.setLimit(5L);
obj1.setAppKey("ant_group");
obj1.setKeyword("承德");
obj1.setEmployeeNo("091103");
req.setCitySearchOpenRequestDto(obj1);
AlibabaTaeCommonSiteSearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTaeCommonSiteSearchRequest req = new AlibabaTaeCommonSiteSearchRequest();
AlibabaTaeCommonSiteSearchRequest.CitySearchOpenRequestDTODomain obj1 = new AlibabaTaeCommonSiteSearchRequest.CitySearchOpenRequestDTODomain();
obj1.TenantKey = "ant";
obj1.Limit = 5L;
obj1.AppKey = "ant_group";
obj1.Keyword = "承德";
obj1.EmployeeNo = "091103";
req.CitySearchOpenRequestDto_ = obj1;
AlibabaTaeCommonSiteSearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTaeCommonSiteSearchRequest;
$city_search_open_request_dto = new CitySearchOpenRequestDTO;
$city_search_open_request_dto->tenant_key="ant";
$city_search_open_request_dto->limit="5";
$city_search_open_request_dto->app_key="ant_group";
$city_search_open_request_dto->keyword="承德";
$city_search_open_request_dto->employee_no="091103";
$req->setCitySearchOpenRequestDto(json_encode($city_search_open_request_dto));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.tae.common.site.search' \
-d 'partner_id=apidoc' \
-d 'sign=A41D14E0C22357663BDC2493BD478B32' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-10-25+07%3A37%3A53' \
-d 'v=2.0' \
-d 'city_search_open_request_dto=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaTaeCommonSiteSearchRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.city_search_open_request_dto="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.tae.common.site.search");
add_param(pRequest,"city_search_open_request_dto","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.tae.common.site.search', {
	'city_search_open_request_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tae_common_site_search_response>
    <result_code>A00001</result_code>
    <result_message>系统错误</result_message>
    <content>
        <id>10367</id>
        <name>承德</name>
    </content>
    <is_success>true</is_success>
</alibaba_tae_common_site_search_response>

{
    "alibaba_tae_common_site_search_response":{
        "result_code":"A00001",
        "result_message":"系统错误",
        "content":{
            "id":10367,
            "name":"承德"
        },
        "is_success":true
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

欢行开发平台API

alibaba.tae.common.site.search (欢行基础城市搜索)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ