查询团队协作¶
通过以下步骤查询协作,该接口可返回团队内所有可用协作app
示例¶
请求cURl:
curl --location --request GET 'https://caweb.aiops.com/api/alert/rest/api/v1/cooperations' \ --user 'email@example.com:<access_token>' \ --header 'Accept: application/json'
access_token如何获取请参考文档 api令牌
提示
• 示例邮箱应替换为用户注册所用邮箱
• access_token应替换为您手动获取的access_token
• 如需对请求进行加密处理:请将
--user 'email@example.com:access_token' \
--header 'Accept: application/json'
替换为:
--header 'Authorization: Basic Z2FveWluaW5nOTk5NUAxNjMuY29tOmt1WWl6bmljZ3oxN0JBVjk=' \
--header 'Content-Type: application/json'
• 替换步骤请参考加密步骤
返回参数¶
| 参数 | 类型 | 说明 |
|---|---|---|
| result | string | 返回结果:success成功 、false 失败 |
| message | string | 返回消息 |
| data | 返回数据集 | |
| totalCount | int | 数据量 |
| code | int | 响应码 |
data结果集¶
| 参数 | 类型 | 说明 |
|---|---|---|
| sysId | string | 协作app id |
| sysType | string | 协作类型 |
| target | string | 地址 |
| description | string | 描述 |
响应报文¶
{
"result":"success",
"message":"ok",
"data":[
{
"sysId":"7ad18da9ac2340e6bae4ad4272bba03e",
"sysType":"workWechat",
"target":"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxxxxxx",
"description":"企业微信",
"tag":null,
"owner":"768215042",
"sysCreatedOn":1649318259359,
"sysUpdatedOn":1649993216879,
"sysDeleted":0,
"jenkinsUsername":null,
"jenkinsPassword":null,
"jenkinsUrl":null,
"bearychatChannel":null,
"active":0,
"status":"ACTIVE",
"chooseAt":2,
"notifyAlarmStatus":"trigger,ack,resolve",
"notifyPriority":"1,2,3",
"notifyCron":0,
"notifyTimePeriod":"* * * * * *",
"email":null,
"subUrl":null,
"password":null
}
],
"totalCount":1,
"code":200
}
错误响应码¶
| 错误码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 失败,传入的参数有问题 |
| 401 | 认证失败,用户名密码错误 |