跳到主要内容

项目管理 API

最近更新 2026/11/12

调用方法请参见Open API文档中的调用方法描述。

建议先阅读 AE 使用手册了解项目管理相关功能:项目管理

1. 用户项目列表​

注意

根据登录名称获取该用户的项目列表

接口URL

/open/project-list?token=xxx&loginName=test007

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
loginNametest007String是登录名称

成功响应示例

{
"data": [
{
"companyId": 1,
"projectId": 2,
"projectName": "产品内测项目",
"projectType": 0,
"remark": "",
"roleName": "root"
},
{
"companyId": 1,
"projectId": 6,
"projectName": "thinkinggame官网线上",
"projectType": 0,
"remark": "",
"roleName": "root"
}
],
"return_code": 0,
"return_message": "success"
}
参数名示例值参数类型参数描述
data-Object返回数据
data.companyId1Integer公司ID
data.projectId2Integer项目ID
data.projectName产品内测项目String项目名称
data.projectType0Integer

项目类型

  • 0:正常项目
  • 1:中文DEMO项目
  • 2:英文DEMO项目
data.remark-String项目备注
data.roleNamerootString角色名称
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
"return_code": -1999,
"return_message": "无效用户"
}
参数名示例值参数类型参数描述
return_code-1999Integer返回码
return_message无效用户String返回信息

2. 更新项目信息​

注意

更新项目信息,当前仅支持项目名称更新

接口URL

/open/project/update-project-info?token=xxx&projectId=2

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID

请求Body参数

{
"projectName": "新项目名称"
}
参数名示例值参数类型是否必填参数描述
projectName新项目名称String是项目名称

成功响应示例

{
"return_code": 0,
"return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
"return_code": -1006,
"return_message": "您无权限操作,请检查token值是否正确"
}
参数名示例值参数类型参数描述
return_code-1006Integer返回码
return_message您无权限操作,请检查token值是否正确String返回信息

3. 创建新项目并生成appId​

注意
  • 会检查项目名称是否存在,若存在则创建失败,返回结果如错误响应示例

接口URL

/open/project/generate-project-app-id?token=xxx&projectName=test007&loadHistory=1

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectNametest007String是项目名称
loadHistory1Integer是

是否打开导入历史数据模式

  • 0:关闭
  • 1:打开

curl示例

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' 'http://ta2:8992/open/project/generate-project-app-id?token=YOUR_TOKEN&projectName=test1222&loadHistory=1'

成功响应示例

{
"data": {
"appid": "2ec39af5e0db4be2a1371b44a7cbedc5",
"projectId": 2535
},
"return_code": 0,
"return_message": "success"
}
参数名示例值参数类型参数描述
data-Object返回数据
data.appid2ec39af5e0db4be2a1371b44a7cbedc5Stringappid
data.projectId2535Integer项目ID
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
"return_code": -1015,
"return_message": "test007已存在"
}
参数名示例值参数类型参数描述
return_code-1015Integer返回码
return_messagetest007已存在String返回信息

4. 批量创建账号并设置单项目分析角色​

为一个项目批量创建账号、添加成员,并全量设置成员的分析角色,可同时指定该项目的数据权限。适用于使用项目 Token 对接账号、角色和数据权限同步的私有化部署环境,不支持 SaaS。

调用条件

使用目标项目的项目 Token,或该项目所属公司的公司 Token。不接受用户 Token、临时 Token、其他项目或其他公司的 Token。密钥获取及服务地址请参见本页面开头的 Open API 调用说明。

POST /open/batch-set-project-roles?token=<TOKEN>
Content-Type: application/json

也可不传 Query 参数 token,改用请求头 Authorization: Bearer <TOKEN>。Content-Type 为 application/json。

请求 Body 参数

参数类型必填说明
authUsersArray是账号列表,不能为空,列表元素不能为 null。
authUsers[].loginNameString是登录账号名,格式规则与批量创建用户接口一致。同一请求中不能重复,大小写不同也视为重复。
authUsers[].rolesArray是该账号在目标项目中的完整分析角色列表,不能为空,列表元素不能为 null。
authUsers[].roles[].projectIdInteger是项目 ID,必须是实际存在的非负整数。整个请求中所有账号、所有角色的 projectId 必须相同;无需额外传 Query 参数 projectId。
authUsers[].roles[].roleDescString是目标项目中已存在、可用的分析角色显示名称,不是角色内部标识。不能为空;重复角色自动去重。
authUsers[].dataPowersArray否该账号的数据权限配置。省略、null 或空数组均保留已有数据权限;新账号或新入项账号未指定时沿用默认全部数据权限。数组元素不能为 null。
authUsers[].dataPowers[].projectIdInteger是必须与该账号 roles 中的目标项目 ID 相同。同一账号不能重复配置该项目。
authUsers[].dataPowers[].dataPowerNameString二选一项目内已存在的自定义数据权限完整名称,按原始名称精确且唯一匹配,不传内部 ID,不模糊匹配,也不自动创建。即使名称为“全部数据”,也仍按自定义权限解析。选择名称时,allData 须省略或为 null。
authUsers[].dataPowers[].allDataBoolean二选一仅允许 true,表示显式授予全部数据权限,与请求语言无关;此时 dataPowerName 须省略或为 null。false、空白名称、两者均未指定或两者同时指定均拒绝。

请求示例

以下示例为项目 57 设置两个账号的完整分析角色,同时为 api_user_1 指定自定义数据权限,为 api_user_2 显式授予全部数据。API Analyst、API Viewer 和 API Data Scope 均为示例名称,请替换为目标项目已有的角色及数据权限名称。若只设置角色,可省略 dataPowers。

{
"authUsers": [
{
"loginName": "api_user_1",
"roles": [
{
"projectId": 57,
"roleDesc": "API Analyst"
},
{
"projectId": 57,
"roleDesc": "API Viewer"
}
],
"dataPowers": [
{
"projectId": 57,
"dataPowerName": "API Data Scope"
}
]
},
{
"loginName": "api_user_2",
"roles": [
{
"projectId": 57,
"roleDesc": "API Viewer"
}
],
"dataPowers": [
{
"projectId": 57,
"allData": true
}
]
}
]
}

执行规则

  • 账号不存在时创建账号,初始密码为 ta2020,账号归属目标项目所在公司;已有账号未加入项目时,将其加入项目。新加入项目的账号会加入默认用户组。
  • 已有成员的目标项目分析角色会被全量替换,而不是追加。例如原来有角色 A、B,本次仅传 B,成功后只保留 B。每次都应传入希望保留的完整角色集合;空列表不能用于移除成员。
  • 只修改本次指定的目标项目数据权限。dataPowers 省略、null 或空数组均保留已有数据权限;自定义权限名称不存在、重复或仅存在于其他项目时整批失败,不回退到全部数据。其他项目及其他平台角色、密码和锁定状态保持不变。公司关闭项目内创建成员时,不允许创建新账号,仍可设置已有账号的项目角色。
  • 不能授予超管、项目负责人、系统管理员等受保护身份,也不能修改具有目标公司或目标项目受保护身份的账号。拒绝其他公司账号、已删除身份,以及其他项目、公司或平台的角色。
  • 整批执行:参数、权限、角色或数据权限校验不通过时,不应用任何变更;写入过程中失败,账号、角色、默认组和数据权限整批回滚。接口不返回部分成功结果。
  • 前一次请求成功完成后,重复提交相同请求会复用账号并设置相同角色,不会重复创建账号或累加角色。同一项目的批次建议顺序调用,不保证并发请求的执行顺序或最终角色集合。

响应

成功响应示例:

{
"return_code": 0,
"return_message": "success"
}

return_code 为 0 表示成功;非 0 表示失败,return_message 提供错误信息。常见失败原因包括参数为空或重复、混入多个项目、Token 权限不足、角色不存在、账号属于其他公司或已删除,以及尝试修改受保护身份。

这篇文档对你有帮助吗?