Open API 开发者文档#

接口访问地址#

接口访问地址即为 CloudQuery 平台访问地址。

接口调用规则#

  • 字符编码使用 UTF-8
  • 对于 POST 请求,数据格式为 application/json

接口调用流程#

下文中「API 入口」指代部署在您的服务器上的 CloudQuery 平台访问地址。

当前支持的使用场景:

  • 获取 App ID 和 Secret
  • 同步部门
  • 同步用户

获取 App ID 和 Secret#

系统管理员在「系统设置 - 开发者中心」授予用户 App ID 和 Secret。

同步部门数据#

POST API 入口/openapi/user/dept

请求参数

参数名称类型是否必填描述是否用户标识加密
appIdstring用户标识 ID
sourcestring数据来源
currentTimenumber当前时间
statusstring加密字段生成的标识 key
departmentInfosobject<DepartmentInfo>部门详情

DepartmentInfo

参数名称参数类型是否必填描述
namestring部门名称
principalstring部门负责人
parentsstring[]当前部门的父部门
childrenstring[]当前部门的子部门
descriptionstring部门描述

请求示例

{
"currentTime": "1624520308159",
"source": "AD 域",
"appId": "ryca9fwJ",
"status": "bb8058d05cec73ba5dac33a9f6e19977",
"departmentInfos": [
{
"name": "DivisonOne",
"parents": ["MarketingDept"],
"principal": "",
"childrens": [],
"description": ""
}
]
}

成功响应

{
"code": 200,
"message": "success"
}

同步用户#

POST API 入口/openapi/user/user/info

请求参数

参数名称类型是否必填描述是否用户标识加密
appIdstring用户标识 ID
sourcestring数据来源
currentTimenumber当前时间
statusstring加密字段生成的标识 key
userInfosobject<UserInfo>用户详情

UserInfo

参数名称类型是否必填描述
Deptstring用户所在部门
userNamestring用户名
userIdstring账号 ID
userGenderstring性别 'MALE', 'FEMALE'
passwordstring登录密码
telephonestring联系电话
jobNumberstring工号
emailstring邮箱

参数请求

{
"currentTime": "1624520308159",
"source": "AD 域",
"appId": "ryca9fwJ",
"status": "bb8058d05cec73ba5dac33a9f6e19977",
"userInfos": [
{
"Dept": "cqUser",
"userName": "测试用户",
"userId": "test123",
"userGender": "MALE",
"password": "abc",
"telephone": "15786547114",
"email": "*cloudQuery**@*bintools.cn",
"jobNumber": "A001"
}
]
}

成功响应

{
"code": 200,
"message": "success"
}

出错排查表#

错误码错误信息排查思路
4600无效 appIdappId 与管理员发放的不一致
4610无效的身份认证secret 不正确。加密认证的 key 与服务器不一致
4620数据同步存在异常数据确认可以查询 CQ 的系统库
4630服务调度异常存在服务没有启动。查看执行日志

更多信息#

欢迎扫码添加小助手微信,加入微信群「CloudQuery 全球 IT 粉丝后援会」交流。

img