阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
workbenchcontext	WorkBenchContext	可选		系统自动生成
└ system_id String 可选 1 系统id └ company_id Number 必须 1 公司id └ campus_id Number 必须 1 园区id └ user_id Number 必须 1 用户ID，passport账户ID
status	Number	可选	1	应用状态
page	Number	必须	1	分页码
size	Number	必须	10	每页容量

名称	类型	示例值	描述
result	PageResult	{}	分页结果
└ error_ext_info String {"errormsg":"请求失败"} 错误详情 └ error_level String 1 错误等级 └ success Boolean true 是否成功 └ error_msg String ok 错误消息 └ error_code String 200 错误码 └ request_id String 1 请求id content Page [] 内容 └ total_page Number 10 总页数 └ current_page Number 1 当前页 └ page_size Number 10 每页大小 └ total_count Number 100 总数量 items Items [] {} 返回参数集合 └ id Number 1 主键ID └ app_id Number 1 应用ID └ campus_id Number 1 园区ID └ status Number 1 应用状态 └ app_name String 神鲸应用名称 └ icon String 应用图标应用图标 └ admin_url String https://xxx.xxx.com 前台URL └ url String https://xxx.xxx.com 后台URL └ open_mode String h5 打开模式 └ description String 这是一个应用应用描述 └ is_charge Boolean true 是否收费类型应用 results Result [] {} 返回参数集合，兼容老Page对象 └ id Number 1 主键ID └ app_id Number 1 应用ID └ campus_id Number 1 园区ID └ status Number 1 应用状态 └ app_name String 神鲸应用名称 └ icon String 应用图标应用图标 └ admin_url String https://xxx.xxx.com 前台URL └ url String https://xxx.xxx.com 后台URL └ open_mode String h5 打开模式 └ description String 这是一个应用应用描述 └ is_charge Boolean true 是否收费类型应用 └ total Number 1 总数据条数 └ limit Number 1 分页限制

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIbWorkcoreAppQueryappusagesRequest req = new AlibabaIbWorkcoreAppQueryappusagesRequest();
AlibabaIbWorkcoreAppQueryappusagesRequest.WorkBenchContext obj1 = new AlibabaIbWorkcoreAppQueryappusagesRequest.WorkBenchContext();
obj1.setSystemId("1");
obj1.setCompanyId(1L);
obj1.setCampusId(1L);
obj1.setUserId(1L);
req.setWorkbenchcontext(obj1);
req.setStatus(1L);
req.setPage(1L);
req.setSize(10L);
AlibabaIbWorkcoreAppQueryappusagesResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIbWorkcoreAppQueryappusagesRequest req = new AlibabaIbWorkcoreAppQueryappusagesRequest();
AlibabaIbWorkcoreAppQueryappusagesRequest.WorkBenchContextDomain obj1 = new AlibabaIbWorkcoreAppQueryappusagesRequest.WorkBenchContextDomain();
obj1.SystemId = "1";
obj1.CompanyId = 1L;
obj1.CampusId = 1L;
obj1.UserId = 1L;
req.Workbenchcontext_ = obj1;
req.Status = 1L;
req.Page = 1L;
req.Size = 10L;
AlibabaIbWorkcoreAppQueryappusagesResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIbWorkcoreAppQueryappusagesRequest;
$workbenchcontext = new WorkBenchContext;
$workbenchcontext->system_id="1";
$workbenchcontext->company_id="1";
$workbenchcontext->campus_id="1";
$workbenchcontext->user_id="1";
$req->setWorkbenchcontext(json_encode($workbenchcontext));
$req->setStatus("1");
$req->setPage("1");
$req->setSize("10");
$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.ib.workcore.app.queryappusages' \
-d 'partner_id=apidoc' \
-d 'sign=4BB057A350DB42259B62DB71D8B1AF47' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+21%3A58%3A49' \
-d 'v=2.0' \
-d 'page=1' \
-d 'size=10' \
-d 'status=1' \
-d 'workbenchcontext=null'

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

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

req.workbenchcontext=""
req.status=1
req.page=1
req.size=10
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.ib.workcore.app.queryappusages");
add_param(pRequest,"workbenchcontext","数据结构JSON示例");
add_param(pRequest,"status","1");
add_param(pRequest,"page","1");
add_param(pRequest,"size","10");
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.ib.workcore.app.queryappusages', {
	'workbenchcontext':'数据结构JSON示例',
	'status':'1',
	'page':'1',
	'size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ib_workcore_app_queryappusages_response>
    <result>
        <error_ext_info>{&quot;errormsg&quot;:&quot;请求失败&quot;}</error_ext_info>
        <error_level>1</error_level>
        <success>true</success>
        <error_msg>ok</error_msg>
        <error_code>200</error_code>
        <request_id>1</request_id>
        <content>
            <total_page>10</total_page>
            <current_page>1</current_page>
            <page_size>10</page_size>
            <total_count>100</total_count>
            <items>
                <items>
                    <id>1</id>
                    <app_id>1</app_id>
                    <campus_id>1</campus_id>
                    <status>1</status>
                    <app_name>神鲸</app_name>
                    <icon>应用图标</icon>
                    <admin_url>https://xxx.xxx.com</admin_url>
                    <url>https://xxx.xxx.com</url>
                    <open_mode>h5</open_mode>
                    <description>这是一个应用</description>
                    <is_charge>true</is_charge>
                </items>
            </items>
            <results>
                <result>
                    <id>1</id>
                    <app_id>1</app_id>
                    <campus_id>1</campus_id>
                    <status>1</status>
                    <app_name>神鲸</app_name>
                    <icon>应用图标</icon>
                    <admin_url>https://xxx.xxx.com</admin_url>
                    <url>https://xxx.xxx.com</url>
                    <open_mode>h5</open_mode>
                    <description>这是一个应用</description>
                    <is_charge>true</is_charge>
                </result>
            </results>
            <total>1</total>
            <limit>1</limit>
        </content>
    </result>
</alibaba_ib_workcore_app_queryappusages_response>

{
    "alibaba_ib_workcore_app_queryappusages_response":{
        "result":{
            "error_ext_info":"{\"errormsg\":\"请求失败\"}",
            "error_level":"1",
            "success":true,
            "error_msg":"ok",
            "error_code":"200",
            "request_id":"1",
            "content":{
                "total_page":10,
                "current_page":1,
                "page_size":10,
                "total_count":100,
                "items":{
                    "items":[
                        {
                            "id":1,
                            "app_id":1,
                            "campus_id":1,
                            "status":1,
                            "app_name":"神鲸",
                            "icon":"应用图标",
                            "admin_url":"https:\/\/xxx.xxx.com",
                            "url":"https:\/\/xxx.xxx.com",
                            "open_mode":"h5",
                            "description":"这是一个应用",
                            "is_charge":true
                        }
                    ]
                },
                "results":{
                    "result":[
                        {
                            "id":1,
                            "app_id":1,
                            "campus_id":1,
                            "status":1,
                            "app_name":"神鲸",
                            "icon":"应用图标",
                            "admin_url":"https:\/\/xxx.xxx.com",
                            "url":"https:\/\/xxx.xxx.com",
                            "open_mode":"h5",
                            "description":"这是一个应用",
                            "is_charge":true
                        }
                    ]
                },
                "total":1,
                "limit":1
            }
        }
    }
}

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.ib.workcore.app.queryappusages (查询应用使用情况)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈