淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
brand_id	Number	可选	111111	默认值：111111	品牌ID
data_ready_types	String	可选	81,82	默认值：81,82	dataReady类型

名称	类型	示例值	描述
data	DateRangeModel []		返回的对象
└ begin_date Number 20230511 数据有效开始日期 └ end_date Number 20230515 数据有效结束日期 └ readyable Boolean true 数据可用 └ type Number 81 81或82
errcode	Number	0	请求成功
errmsg	String	查询成功	查询成功
code_class	String	SUCCESS	查询成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDatabankOpenOneserviceDatareadyRequest req = new AlibabaDatabankOpenOneserviceDatareadyRequest();
req.setBrandId(111111L);
req.setDataReadyTypes("81,82");
AlibabaDatabankOpenOneserviceDatareadyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDatabankOpenOneserviceDatareadyRequest req = new AlibabaDatabankOpenOneserviceDatareadyRequest();
req.BrandId = 111111L;
req.DataReadyTypes = "81,82";
AlibabaDatabankOpenOneserviceDatareadyResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDatabankOpenOneserviceDatareadyRequest;
$req->setBrandId("111111");
$req->setDataReadyTypes("81,82");
$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.databank.open.oneservice.dataready' \
-d 'partner_id=apidoc' \
-d 'sign=023D0604FFAF98A28C30DAAD87F01350' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+17%3A33%3A17' \
-d 'v=2.0' \
-d 'brand_id=111111' \
-d 'data_ready_types=81%2C82'

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

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

req.brand_id=111111
req.data_ready_types="81,82"
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.databank.open.oneservice.dataready");
add_param(pRequest,"brand_id","111111");
add_param(pRequest,"data_ready_types","81,82");
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.databank.open.oneservice.dataready', {
	'brand_id':'111111',
	'data_ready_types':'81,82'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_databank_open_oneservice_dataready_response>
    <data>
        <date_range_model>
            <begin_date>20230511</begin_date>
            <end_date>20230515</end_date>
            <readyable>true</readyable>
            <type>81</type>
        </date_range_model>
    </data>
    <errcode>0</errcode>
    <errmsg>查询成功</errmsg>
    <code_class>SUCCESS</code_class>
</alibaba_databank_open_oneservice_dataready_response>

{
    "alibaba_databank_open_oneservice_dataready_response":{
        "data":{
            "date_range_model":[
                {
                    "begin_date":20230511,
                    "end_date":20230515,
                    "readyable":true,
                    "type":81
                }
            ]
        },
        "errcode":0,
        "errmsg":"查询成功",
        "code_class":"SUCCESS"
    }
}

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.databank.open.oneservice.dataready (瓴羊DaaS消费者增长CGP查询DataReady)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ