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

请求地址：

环境	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	必须	系统入参
└ company_id Number 可选 1000 公司id └ system_id String 必须 Os162356633 应用id └ campus_id Number 必须 1 园区id
rolequeryparam	RoleQueryParam	可选	入参
└ dept_id String 可选 1 园区id └ role_name String 可选超管角色名称 └ role_key String 可选 ROLE_CRM_ADMIN 角色key └ only_tenant_role Boolean 可选 true 是否只查询租户角色 └ app_keys String [] 可选 [] 支持多应用 └ status String 可选 publish 角色状态 └ role_type String 可选 admin 角色类型

名称	类型	示例值	描述
result	ListResult	{}	结果
└ success Boolean true 接口调用是否成功 └ error_code String 200 错误码 └ total_count Number 20 总记录数 contents SysRoleDto [] [] content └ id Number 1 角色主键id └ role_key String ROLE_SYSTEM 角色key └ tenant String 10000 租户id └ app_key String Os162356633 应用key └ dept_id String 1 园区id └ dept_name String name 园区名称 └ role_name String 超管角色名称 └ role_desc String 超管角色描述 └ role_type String admin 角色类型 └ status String publish 角色状态 └ error_msg String 参数不能null 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIbosAclNewListrolesRequest req = new AlibabaIbosAclNewListrolesRequest();
AlibabaIbosAclNewListrolesRequest.WorkBenchContext obj1 = new AlibabaIbosAclNewListrolesRequest.WorkBenchContext();
obj1.setCompanyId(1000L);
obj1.setSystemId("Os162356633");
obj1.setCampusId(1L);
req.setWorkbenchcontext(obj1);
AlibabaIbosAclNewListrolesRequest.RoleQueryParam obj2 = new AlibabaIbosAclNewListrolesRequest.RoleQueryParam();
obj2.setDeptId("1");
obj2.setRoleName("超管");
obj2.setRoleKey("ROLE_CRM_ADMIN");
obj2.setOnlyTenantRole(true);
obj2.setAppKeys("");
obj2.setStatus("publish");
obj2.setRoleType("admin");
req.setRolequeryparam(obj2);
AlibabaIbosAclNewListrolesResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIbosAclNewListrolesRequest req = new AlibabaIbosAclNewListrolesRequest();
AlibabaIbosAclNewListrolesRequest.WorkBenchContextDomain obj1 = new AlibabaIbosAclNewListrolesRequest.WorkBenchContextDomain();
obj1.CompanyId = 1000L;
obj1.SystemId = "Os162356633";
obj1.CampusId = 1L;
req.Workbenchcontext_ = obj1;
AlibabaIbosAclNewListrolesRequest.RoleQueryParamDomain obj2 = new AlibabaIbosAclNewListrolesRequest.RoleQueryParamDomain();
obj2.DeptId = "1";
obj2.RoleName = "超管";
obj2.RoleKey = "ROLE_CRM_ADMIN";
obj2.OnlyTenantRole = true;
obj2.AppKeys = "";
obj2.Status = "publish";
obj2.RoleType = "admin";
req.Rolequeryparam_ = obj2;
AlibabaIbosAclNewListrolesResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIbosAclNewListrolesRequest;
$workbenchcontext = new WorkBenchContext;
$workbenchcontext->company_id="1000";
$workbenchcontext->system_id="Os162356633";
$workbenchcontext->campus_id="1";
$req->setWorkbenchcontext(json_encode($workbenchcontext));
$rolequeryparam = new RoleQueryParam;
$rolequeryparam->dept_id="1";
$rolequeryparam->role_name="超管";
$rolequeryparam->role_key="ROLE_CRM_ADMIN";
$rolequeryparam->only_tenant_role="true";
$rolequeryparam->app_keys="[]";
$rolequeryparam->status="publish";
$rolequeryparam->role_type="admin";
$req->setRolequeryparam(json_encode($rolequeryparam));
$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.ibos.acl.new.listroles' \
-d 'partner_id=apidoc' \
-d 'sign=283FF64B4A664B6A5A3868F551A382ED' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-08-23+08%3A10%3A35' \
-d 'v=2.0' \
-d 'rolequeryparam=null' \
-d 'workbenchcontext=null'

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

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

req.workbenchcontext=""
req.rolequeryparam=""
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.ibos.acl.new.listroles");
add_param(pRequest,"workbenchcontext","数据结构JSON示例");
add_param(pRequest,"rolequeryparam","数据结构JSON示例");
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.ibos.acl.new.listroles', {
	'workbenchcontext':'数据结构JSON示例',
	'rolequeryparam':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ibos_acl_new_listroles_response>
    <result>
        <success>true</success>
        <error_code>200</error_code>
        <total_count>20</total_count>
        <contents>
            <sys_role_dto>
                <id>1</id>
                <role_key>ROLE_SYSTEM</role_key>
                <tenant>10000</tenant>
                <app_key>Os162356633</app_key>
                <dept_id>1</dept_id>
                <dept_name>name</dept_name>
                <role_name>超管</role_name>
                <role_desc>超管</role_desc>
                <role_type>admin</role_type>
                <status>publish</status>
            </sys_role_dto>
        </contents>
        <error_msg>参数不能null</error_msg>
    </result>
</alibaba_ibos_acl_new_listroles_response>

{
    "alibaba_ibos_acl_new_listroles_response":{
        "result":{
            "success":true,
            "error_code":"200",
            "total_count":20,
            "contents":{
                "sys_role_dto":[
                    {
                        "id":1,
                        "role_key":"ROLE_SYSTEM",
                        "tenant":"10000",
                        "app_key":"Os162356633",
                        "dept_id":"1",
                        "dept_name":"name",
                        "role_name":"超管",
                        "role_desc":"超管",
                        "role_type":"admin",
                        "status":"publish"
                    }
                ]
            },
            "error_msg":"参数不能null"
        }
    }
}

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

智慧建筑IBOS

alibaba.ibos.acl.new.listroles (查询全部角色)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈