淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
pen_name	String	可选	张大炮	penName
ip	String	可选	10.129.6.68	ip
page_size	Number	必须	20	pageSize
page	Number	必须	1	page
citys	String	可选	1	citys
action_name	String	可选	1	actionName

名称	类型	示例值	描述
result	CommonResponse		result
data OgnvAliAuthorIpListResp data └ count Number 1 count └ page Number 1 page ip_list IpItem [] ipList └ real_name String 别操作 realName └ up_time String 2020-01-22 10:25:11 upTime └ pen_name String 张大炮 penName └ ip_num Number 132 ipNum └ ip String 10.129.6.68 ip └ citys String 其他\|其他\|其他 citys └ user_id Number 268581419 userId └ state Number 200 state └ message String ok message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvaliauthorIplistRequest req = new AlibabaShuqiOriginalBackendOgnvaliauthorIplistRequest();
req.setPenName("张大炮");
req.setIp("10.129.6.68");
req.setPageSize(20L);
req.setPage(1L);
req.setCitys("1");
req.setActionName("1");
AlibabaShuqiOriginalBackendOgnvaliauthorIplistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendOgnvaliauthorIplistRequest req = new AlibabaShuqiOriginalBackendOgnvaliauthorIplistRequest();
req.PenName = "张大炮";
req.Ip = "10.129.6.68";
req.PageSize = 20L;
req.Page = 1L;
req.Citys = "1";
req.ActionName = "1";
AlibabaShuqiOriginalBackendOgnvaliauthorIplistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendOgnvaliauthorIplistRequest;
$req->setPenName("张大炮");
$req->setIp("10.129.6.68");
$req->setPageSize("20");
$req->setPage("1");
$req->setCitys("1");
$req->setActionName("1");
$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.shuqi.original.backend.ognvaliauthor.iplist' \
-d 'partner_id=apidoc' \
-d 'sign=C12223EBD04E191F30DBC0A06FE1DD14' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+03%3A57%3A13' \
-d 'v=2.0' \
-d 'action_name=1' \
-d 'citys=1' \
-d 'ip=10.129.6.68' \
-d 'page=1' \
-d 'page_size=20' \
-d 'pen_name=%E5%BC%A0%E5%A4%A7%E7%82%AE'

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

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

req.pen_name="张大炮"
req.ip="10.129.6.68"
req.page_size=20
req.page=1
req.citys="1"
req.action_name="1"
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.shuqi.original.backend.ognvaliauthor.iplist");
add_param(pRequest,"pen_name","张大炮");
add_param(pRequest,"ip","10.129.6.68");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page","1");
add_param(pRequest,"citys","1");
add_param(pRequest,"action_name","1");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.shuqi.original.backend.ognvaliauthor.iplist', {
	'pen_name':'张大炮',
	'ip':'10.129.6.68',
	'page_size':'20',
	'page':'1',
	'citys':'1',
	'action_name':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_ognvaliauthor_iplist_response>
    <result>
        <data>
            <count>1</count>
            <page>1</page>
            <ip_list>
                <ip_item>
                    <real_name>别操作</real_name>
                    <up_time>2020-01-22 10:25:11</up_time>
                    <pen_name>张大炮</pen_name>
                    <ip_num>132</ip_num>
                    <ip>10.129.6.68</ip>
                    <citys>其他|其他|其他</citys>
                    <user_id>268581419</user_id>
                </ip_item>
            </ip_list>
        </data>
        <state>200</state>
        <message>ok</message>
    </result>
</alibaba_shuqi_original_backend_ognvaliauthor_iplist_response>

{
    "alibaba_shuqi_original_backend_ognvaliauthor_iplist_response":{
        "result":{
            "data":{
                "count":1,
                "page":1,
                "ip_list":{
                    "ip_item":[
                        {
                            "real_name":"别操作",
                            "up_time":"2020-01-22 10:25:11",
                            "pen_name":"张大炮",
                            "ip_num":132,
                            "ip":"10.129.6.68",
                            "citys":"其他|其他|其他",
                            "user_id":268581419
                        }
                    ]
                }
            },
            "state":200,
            "message":"ok"
        }
    }
}

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下载

开放平台

书旗内容文巢

alibaba.shuqi.original.backend.ognvaliauthor.iplist (作者IP统计列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ