淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
repository_do	ApiRepositoryDo	必须			1
└ service_type Number 可选 1 1 └ agreement_type Number 可选 1 1 └ gmt_modified Date 可选 2017-12-12 12:12:12 1 └ service_property String 可选 1 1 └ code String 可选 1 1 └ privilege_level Number 可选 1 1 └ fields_read_level String 可选 1 1 └ description String 可选 1 1 └ api_draft String 可选 1 1 └ title String 可选 1 1 └ open_type Number 可选 1 1 └ api_version String 可选 1 1 └ runtime_foreign_id Number 可选 1 1 └ layout_type Number 可选 1 1 └ id Number 可选 1 1 └ auth_type Number 可选 1 1 └ aone_name String 可选 1 1 └ publish_time Date 可选 2017-12-12 12:12:12 1 └ resource_domain_key String 可选 1 1 └ read_write_type Number 可选 1 1 └ author String 可选 1 1 └ is_published Number 可选 1 1 └ open_api_id Number 可选 1 1 └ top_token Number 可选 1 1 └ gmt_create Date 可选 2017-12-12 12:12:12 1 └ node String 可选 1 1 label_list ApiLabelDo [] 可选 1 └ id Number 可选 1 1 └ name String 可选 1 1 └ doc_name String 可选 1 1 └ doc_visible Number 可选 1 1 └ description String 可选 1 1 └ out_doc_url String 可选 1 1 └ icon_url String 可选 1 1 └ gmt_create Date 可选 2017-12-12 12:12:12 1 └ gmt_modified Date 可选 2017-12-12 12:12:12 1 └ partner String 可选 1 1 └ managed_foreign_id Number 可选 1 1 └ second_api_type Number 可选 1 1 └ api_type Number 可选 1 1 └ api_status Number 可选 1 1 └ front_category_id Number 可选 1 前台类目 └ backend_category_id Number 可选 1 后台类目
api_define_xml	String	可选	1	默认值：1	1
work_id	String	可选	1	默认值：1	1

名称	类型	示例值	描述
service_error_code	String	invalid-parameter	错误码
service_error_msg	String	参数错误	错误信息
operation	String	123	123
service_success	Boolean	true	调用是否成功
data	Boolean	true	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AompApiDeployDailyRequest req = new AompApiDeployDailyRequest();
AompApiDeployDailyRequest.ApiRepositoryDo obj1 = new AompApiDeployDailyRequest.ApiRepositoryDo();
obj1.setServiceType(1L);
obj1.setAgreementType(1L);
obj1.setGmtModified(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setServiceProperty("1");
obj1.setCode("1");
obj1.setPrivilegeLevel(1L);
obj1.setFieldsReadLevel("1");
obj1.setDescription("1");
obj1.setApiDraft("1");
obj1.setTitle("1");
obj1.setOpenType(1L);
obj1.setApiVersion("1");
obj1.setRuntimeForeignId(1L);
obj1.setLayoutType(1L);
obj1.setId(1L);
obj1.setAuthType(1L);
obj1.setAoneName("1");
obj1.setPublishTime(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setResourceDomainKey("1");
obj1.setReadWriteType(1L);
obj1.setAuthor("1");
obj1.setIsPublished(1L);
obj1.setOpenApiId(1L);
obj1.setTopToken(1L);
obj1.setGmtCreate(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setNode("1");
List<AompApiDeployDailyRequest.ApiLabelDo> list3 = new ArrayList<AompApiDeployDailyRequest.ApiLabelDo>();
AompApiDeployDailyRequest.ApiLabelDo obj4 = new AompApiDeployDailyRequest.ApiLabelDo();
list3.add(obj4);
obj4.setId(1L);
obj4.setName("1");
obj4.setDocName("1");
obj4.setDocVisible(1L);
obj4.setDescription("1");
obj4.setOutDocUrl("1");
obj4.setIconUrl("1");
obj4.setGmtCreate(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj4.setGmtModified(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setLabelList(list3);
obj1.setPartner("1");
obj1.setManagedForeignId(1L);
obj1.setSecondApiType(1L);
obj1.setApiType(1L);
obj1.setApiStatus(1L);
obj1.setFrontCategoryId(1L);
obj1.setBackendCategoryId(1L);
req.setRepositoryDo(obj1);
req.setApiDefineXml("1");
req.setWorkId("1");
AompApiDeployDailyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AompApiDeployDailyRequest req = new AompApiDeployDailyRequest();
AompApiDeployDailyRequest.ApiRepositoryDoDomain obj1 = new AompApiDeployDailyRequest.ApiRepositoryDoDomain();
obj1.ServiceType = 1L;
obj1.AgreementType = 1L;
obj1.GmtModified = DateTime.Parse(2017-12-12 12:12:12");
obj1.ServiceProperty = "1";
obj1.Code = "1";
obj1.PrivilegeLevel = 1L;
obj1.FieldsReadLevel = "1";
obj1.Description = "1";
obj1.ApiDraft = "1";
obj1.Title = "1";
obj1.OpenType = 1L;
obj1.ApiVersion = "1";
obj1.RuntimeForeignId = 1L;
obj1.LayoutType = 1L;
obj1.Id = 1L;
obj1.AuthType = 1L;
obj1.AoneName = "1";
obj1.PublishTime = DateTime.Parse(2017-12-12 12:12:12");
obj1.ResourceDomainKey = "1";
obj1.ReadWriteType = 1L;
obj1.Author = "1";
obj1.IsPublished = 1L;
obj1.OpenApiId = 1L;
obj1.TopToken = 1L;
obj1.GmtCreate = DateTime.Parse(2017-12-12 12:12:12");
obj1.Node = "1";
List<AompApiDeployDailyRequest.ApiLabelDoDomain> list3 = new List<AompApiDeployDailyRequest.ApiLabelDoDomain>();
AompApiDeployDailyRequest.ApiLabelDoDomain obj4 = new AompApiDeployDailyRequest.ApiLabelDoDomain();
list3.Add(obj4);
obj4.Id = 1L;
obj4.Name = "1";
obj4.DocName = "1";
obj4.DocVisible = 1L;
obj4.Description = "1";
obj4.OutDocUrl = "1";
obj4.IconUrl = "1";
obj4.GmtCreate = DateTime.Parse(2017-12-12 12:12:12");
obj4.GmtModified = DateTime.Parse(2017-12-12 12:12:12");
obj1.LabelList= list3;
obj1.Partner = "1";
obj1.ManagedForeignId = 1L;
obj1.SecondApiType = 1L;
obj1.ApiType = 1L;
obj1.ApiStatus = 1L;
obj1.FrontCategoryId = 1L;
obj1.BackendCategoryId = 1L;
req.RepositoryDo_ = obj1;
req.ApiDefineXml = "1";
req.WorkId = "1";
AompApiDeployDailyResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AompApiDeployDailyRequest;
$repository_do = new ApiRepositoryDo;
$repository_do->service_type="1";
$repository_do->agreement_type="1";
$repository_do->gmt_modified="2017-12-12 12:12:12";
$repository_do->service_property="1";
$repository_do->code="1";
$repository_do->privilege_level="1";
$repository_do->fields_read_level="1";
$repository_do->description="1";
$repository_do->api_draft="1";
$repository_do->title="1";
$repository_do->open_type="1";
$repository_do->api_version="1";
$repository_do->runtime_foreign_id="1";
$repository_do->layout_type="1";
$repository_do->id="1";
$repository_do->auth_type="1";
$repository_do->aone_name="1";
$repository_do->publish_time="2017-12-12 12:12:12";
$repository_do->resource_domain_key="1";
$repository_do->read_write_type="1";
$repository_do->author="1";
$repository_do->is_published="1";
$repository_do->open_api_id="1";
$repository_do->top_token="1";
$repository_do->gmt_create="2017-12-12 12:12:12";
$repository_do->node="1";
$label_list = new ApiLabelDo;
$label_list->id="1";
$label_list->name="1";
$label_list->doc_name="1";
$label_list->doc_visible="1";
$label_list->description="1";
$label_list->out_doc_url="1";
$label_list->icon_url="1";
$label_list->gmt_create="2017-12-12 12:12:12";
$label_list->gmt_modified="2017-12-12 12:12:12";
$repository_do->label_list = $label_list;
$repository_do->partner="1";
$repository_do->managed_foreign_id="1";
$repository_do->second_api_type="1";
$repository_do->api_type="1";
$repository_do->api_status="1";
$repository_do->front_category_id="1";
$repository_do->backend_category_id="1";
$req->setRepositoryDo(json_encode($repository_do));
$req->setApiDefineXml("1");
$req->setWorkId("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=taobao.aomp.api.deploy.daily' \
-d 'partner_id=apidoc' \
-d 'sign=D1DECA6B3CF44D1E7699D56462A735AF' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-01-10+07%3A09%3A25' \
-d 'v=2.0' \
-d 'api_define_xml=1' \
-d 'repository_do=null' \
-d 'work_id=1'

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

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

req.repository_do=""
req.api_define_xml="1"
req.work_id="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,"taobao.aomp.api.deploy.daily");
add_param(pRequest,"repository_do","数据结构JSON示例");
add_param(pRequest,"api_define_xml","1");
add_param(pRequest,"work_id","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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.aomp.api.deploy.daily', {
	'repository_do':'数据结构JSON示例',
	'api_define_xml':'1',
	'work_id':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<aomp_api_deploy_daily_response>
    <service_error_code>invalid-parameter</service_error_code>
    <service_error_msg>参数错误</service_error_msg>
    <operation>123</operation>
    <service_success>true</service_success>
    <data>true</data>
</aomp_api_deploy_daily_response>

{
    "aomp_api_deploy_daily_response":{
        "service_error_code":"invalid-parameter",
        "service_error_msg":"参数错误",
        "operation":"123",
        "service_success":true,
        "data":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

taobao.aomp.api.deploy.daily (aomp部署api到日常环境)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ