淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
server_list_query_v3_req_dto	ServerListQueryV3ReqDTO	必须			服务器列表查询请求
└ game_id Number 可选 12345 游戏ID └ cid Number 可选 1 分类ID └ client_id Number 可选 1 客户端ID └ server_id Number 可选 1 服务器ID（传值时忽略其他条件直接查该服务器） └ scene Number 可选 1 场景（空则默认走V2逻辑） └ keyword String 可选 xxx 服务器名称搜索关键词 └ page Number 可选 1 页码 └ page_size Number 可选 20 每页大小

名称	类型	示例值	描述
result	ResultDTO		返回结果
result SearchServerListV3Result 服务器列表查询结果 server_list GoodsServerDTO [] 服务器列表 └ id Number 1 服务器ID └ game_id Number 1 游戏ID └ domain_id Number 1 域名ID └ name String xxx 服务器名称 └ grade Number 1 等级 └ is_top Number 1 是否置顶 domain_info GoodsDomainDTO 区服信息 └ id Number 1 区ID └ game_id Number 1 游戏ID └ name String xxx 区名称 └ grade Number 1 等级 └ sub_code_alias String sub_code_alias 子错误码 └ success_alias Boolean true 是否成功 └ sub_extra_err_msg String sub_extra_err_msg 子错误描述 └ state_code String state_code 错误码 └ extra_err_msg String extra_err_msg 错误详细描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaJymGoodsGameServerlistSearchRequest req = new AlibabaJymGoodsGameServerlistSearchRequest();
AlibabaJymGoodsGameServerlistSearchRequest.ServerListQueryV3ReqDTO obj1 = new AlibabaJymGoodsGameServerlistSearchRequest.ServerListQueryV3ReqDTO();
obj1.setGameId(12345L);
obj1.setCid(1L);
obj1.setClientId(1L);
obj1.setServerId(1L);
obj1.setScene(1L);
obj1.setKeyword("xxx");
obj1.setPage(1L);
obj1.setPageSize(20L);
req.setServerListQueryV3ReqDto(obj1);
AlibabaJymGoodsGameServerlistSearchResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaJymGoodsGameServerlistSearchRequest req = new AlibabaJymGoodsGameServerlistSearchRequest();
AlibabaJymGoodsGameServerlistSearchRequest.ServerListQueryV3ReqDTODomain obj1 = new AlibabaJymGoodsGameServerlistSearchRequest.ServerListQueryV3ReqDTODomain();
obj1.GameId = 12345L;
obj1.Cid = 1L;
obj1.ClientId = 1L;
obj1.ServerId = 1L;
obj1.Scene = 1L;
obj1.Keyword = "xxx";
obj1.Page = 1L;
obj1.PageSize = 20L;
req.ServerListQueryV3ReqDto_ = obj1;
AlibabaJymGoodsGameServerlistSearchResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaJymGoodsGameServerlistSearchRequest;
$server_list_query_v3_req_dto = new ServerListQueryV3ReqDTO;
$server_list_query_v3_req_dto->game_id="12345";
$server_list_query_v3_req_dto->cid="1";
$server_list_query_v3_req_dto->client_id="1";
$server_list_query_v3_req_dto->server_id="1";
$server_list_query_v3_req_dto->scene="1";
$server_list_query_v3_req_dto->keyword="xxx";
$server_list_query_v3_req_dto->page="1";
$server_list_query_v3_req_dto->page_size="20";
$req->setServerListQueryV3ReqDto(json_encode($server_list_query_v3_req_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.jym.goods.game.serverlist.search' \
-d 'partner_id=apidoc' \
-d 'sign=989418220E4B4E428911AB2E86485CE7' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-09-30+07%3A36%3A05' \
-d 'v=2.0' \
-d 'server_list_query_v3_req_dto=null'

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

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

req.server_list_query_v3_req_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.jym.goods.game.serverlist.search");
add_param(pRequest,"server_list_query_v3_req_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.jym.goods.game.serverlist.search', {
	'server_list_query_v3_req_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_jym_goods_game_serverlist_search_response>
    <result>
        <result>
            <server_list>
                <goods_server_d_t_o>
                    <id>1</id>
                    <game_id>1</game_id>
                    <domain_id>1</domain_id>
                    <name>xxx</name>
                    <grade>1</grade>
                    <is_top>1</is_top>
                    <domain_info>
                        <id>1</id>
                        <game_id>1</game_id>
                        <name>xxx</name>
                        <grade>1</grade>
                    </domain_info>
                </goods_server_d_t_o>
            </server_list>
        </result>
        <sub_code_alias>sub_code_alias</sub_code_alias>
        <success_alias>true</success_alias>
        <sub_extra_err_msg>sub_extra_err_msg</sub_extra_err_msg>
        <state_code>state_code</state_code>
        <extra_err_msg>extra_err_msg</extra_err_msg>
    </result>
</alibaba_jym_goods_game_serverlist_search_response>

{
    "alibaba_jym_goods_game_serverlist_search_response":{
        "result":{
            "result":{
                "server_list":{
                    "goods_server_d_t_o":[
                        {
                            "id":1,
                            "game_id":1,
                            "domain_id":1,
                            "name":"xxx",
                            "grade":1,
                            "is_top":1,
                            "domain_info":{
                                "id":1,
                                "game_id":1,
                                "name":"xxx",
                                "grade":1
                            }
                        }
                    ]
                }
            },
            "sub_code_alias":"sub_code_alias",
            "success_alias":true,
            "sub_extra_err_msg":"sub_extra_err_msg",
            "state_code":"state_code",
            "extra_err_msg":"extra_err_msg"
        }
    }
}

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.jym.goods.game.serverlist.search (服务器列表查询V3)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ