淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
field_name	String	可选	1	fieldName
field_category	Number	可选	1	fieldCategory
page_size	Number	可选	1	pageSize
id	Number	可选	1	id
page	Number	可选	1	page
field_type	Number	可选	1	fieldType

名称	类型	示例值	描述
result	LongChapterEditResult		result
data OgnvFieldRuleQueryResp data └ pages Number 1 pages └ totals Number 1 totals field_rule_list OgnvFieldDto [] fieldRuleList └ up_time Number 1588046343 upTime └ cr_time Number 1588046343 crTime └ field_name String bookId fieldName └ rule_list String [] ruleList └ field_category Number 4 fieldCategory └ description String 正文书籍id description └ id Number 118 id └ field_type Number 1 fieldType └ state Number 200 state └ message String demo message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldRequest req = new AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldRequest();
req.setFieldName("1");
req.setFieldCategory(1L);
req.setPageSize(1L);
req.setId(1L);
req.setPage(1L);
req.setFieldType(1L);
AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldRequest req = new AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldRequest();
req.FieldName = "1";
req.FieldCategory = 1L;
req.PageSize = 1L;
req.Id = 1L;
req.Page = 1L;
req.FieldType = 1L;
AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalCopyrightOgnvcpfieldSearchfieldRequest;
$req->setFieldName("1");
$req->setFieldCategory("1");
$req->setPageSize("1");
$req->setId("1");
$req->setPage("1");
$req->setFieldType("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.copyright.ognvcpfield.searchfield' \
-d 'partner_id=apidoc' \
-d 'sign=0328387FEC41FBAD322DFC18EB685C7C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+02%3A28%3A21' \
-d 'v=2.0' \
-d 'field_category=1' \
-d 'field_name=1' \
-d 'field_type=1' \
-d 'id=1' \
-d 'page=1' \
-d 'page_size=1'

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

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

req.field_name="1"
req.field_category=1
req.page_size=1
req.id=1
req.page=1
req.field_type=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.copyright.ognvcpfield.searchfield");
add_param(pRequest,"field_name","1");
add_param(pRequest,"field_category","1");
add_param(pRequest,"page_size","1");
add_param(pRequest,"id","1");
add_param(pRequest,"page","1");
add_param(pRequest,"field_type","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.copyright.ognvcpfield.searchfield', {
	'field_name':'1',
	'field_category':'1',
	'page_size':'1',
	'id':'1',
	'page':'1',
	'field_type':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_copyright_ognvcpfield_searchfield_response>
    <result>
        <data>
            <pages>1</pages>
            <totals>1</totals>
            <field_rule_list>
                <ognv_field_dto>
                    <up_time>1588046343</up_time>
                    <cr_time>1588046343</cr_time>
                    <field_name>bookId</field_name>
                    <rule_list>
                        <string></string>
                    </rule_list>
                    <field_category>4</field_category>
                    <description>正文书籍id</description>
                    <id>118</id>
                    <field_type>1</field_type>
                </ognv_field_dto>
            </field_rule_list>
        </data>
        <state>200</state>
        <message>demo</message>
    </result>
</alibaba_shuqi_original_copyright_ognvcpfield_searchfield_response>

{
    "alibaba_shuqi_original_copyright_ognvcpfield_searchfield_response":{
        "result":{
            "data":{
                "pages":1,
                "totals":1,
                "field_rule_list":{
                    "ognv_field_dto":[
                        {
                            "up_time":1588046343,
                            "cr_time":1588046343,
                            "field_name":"bookId",
                            "rule_list":{
                                "string":[
                                    ""
                                ]
                            },
                            "field_category":4,
                            "description":"正文书籍id",
                            "id":118,
                            "field_type":1
                        }
                    ]
                }
            },
            "state":200,
            "message":"demo"
        }
    }
}

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.copyright.ognvcpfield.searchfield (目标字段列表-查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ