查询执行器列表 - getTepListsByGroupUsingPOST
功能介绍
根据条件,查询功能自动化执行器列表
调用方法
请参见如何调用API。
URI
POST /attask/v1/ticc/tepsByGroup/{serviceId}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| serviceId | 是 | String | 参数解释 服务Id 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 获取方式 从 GET /rest/me 的返回结果中 projectId 字段获取。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| x-auth-token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| groupField | 否 | String | 分组字段 |
| tepmanagerId | 否 | String | 执行器管理ID 获取方式 从 POST /attask/v1/ticc/tepsByGroup/{serviceId} 的返回结果中对应的id字段获取。 |
| noPage | 否 | Boolean | 是否分页 |
| lastOccupyInfo | 否 | Boolean | 是否查询当前占用执行器的任务信息 |
| coldDataFlag | 否 | Boolean | 冷数据开关,默认关闭 |
| where | 否 | Array of objects | 查询条件 |
| option | 否 | Object | 排序 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态:ok - 成功 |
| result | result object | 返回结果 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 总记录数 |
| tep_list | Array of tep_list objects | 执行器列表 |
| page | Integer | 当前分页页码 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rg_id | String | 区域ID |
| group_id | String | 设备分组ID |
| tep_type | String | 执行器类型 |
| type | String | 系统类型 |
| extend_parameter | String | 扩展参数,JSON字符串 |
| device_name | String | 设备名称 |
| using_state | String | 使用状态:idle - 空闲,using - 使用中,unuse - 未使用,error - 错误 |
| register_code_id | String | 注册码ID |
| tep_ip | String | 执行器设备IP |
| ins_type | Integer | 实例类型:0 - 非共享,1 - 共享 |
| share | Integer | 是否共享(0-否,1-是) |
| id | String | 主键ID |
| state | String | 状态:idle - 空闲,using - 使用中,unuse - 未使用,error - 错误 |
| last_release | String | 最后一次发布信息 |
| group_code | String | 分组编码 |
| workspace_id | String | 工作空间ID |
| tenant_share | Integer | 租户共享标识 |
| product_id | String | 产品ID |
| ip | String | IP地址 |
| group_i_d | String | 组ID(与group_id重复,建议梳理) |
| sendtc_type | String | 数据推送类型:push - 推送,pull - 拉取 |
| device_version | String | 设备版本 |
| url | String | 设备访问地址 |
| create_time | String | 创建时间 |
| env_type | String | 环境类型 |
| name | String | 设备名称 |
| location | String | 设备实体位置 |
| project_id | String | 项目ID |
| status | String | 状态码:idle - 空闲,using - 使用中,unuse - 未使用,error - 错误 |
状态码:201
Created
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态:"failed" - 失败 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| error_msg | String | 错误信息 |
| error_code | String | 错误码 |
| error_cause | String | 错误原因 |
| faq | String | faq内容 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态:"failed" - 失败 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| error_msg | String | 错误信息 |
| error_code | String | 错误码 |
| error_cause | String | 错误原因 |
| faq | String | faq内容 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 请求状态:"failed" - 失败 |
| request_id | String | 请求id |
| server_ip | String | 服务节点IP |
| error_msg | String | 错误信息 |
| error_code | String | 错误码 |
| error_cause | String | 错误原因 |
| faq | String | faq内容 |
请求示例
查询执行器列表
post https://{endpoint}/attask/v1/ticc/tepsByGroup/{serviceId}
{
"groupField" : "",
"tepmanagerId" : "",
"noPage" : false,
"lastOccupyInfo" : true,
"where" : [ ],
"option" : {
"by" : "groupId",
"limit" : 15,
"start" : 0,
"order" : "asc"
}
} 响应示例
状态码:200
OK
{
"status" : "ok",
"result" : {
"total" : 2,
"tep_list" : [ {
"teps_info" : [ {
"rg_id" : "",
"group_id" : "tep_agaent",
"tep_type" : "Ticc_System_Type",
"type" : "Ticc_System_Type",
"extend_parameter" : "{}",
"device_name" : "tep_agaent",
"using_state" : "error",
"register_code_id" : 2277940943820685300,
"tep_ip" : "tep_agaent",
"ins_type" : 0,
"share" : 0,
"id" : "1978939305211066880",
"state" : "error",
"last_release" : "260558135576441651226055813557644165142605581390124154880",
"group_code" : "",
"workspace_id" : "",
"tenant_share" : 0,
"product_id" : "7b90e408636344328e44bf70bbae8351",
"ip" : "tep_agaent",
"group_i_d" : "tep_agaent",
"sendtc_type" : "pull",
"device_version" : "",
"url" : "",
"create_time" : "2025-05-27T11:52:37.000+00:00",
"env_type" : "",
"name" : "tep_agaent",
"location" : "",
"project_id" : "919992d350be469b85bfca4af6955cb6",
"status" : "idel"
} ],
"group_name" : ""
} ],
"page" : 1
},
"request_id" : "",
"server_ip" : ""
} 状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
错误码
请参见错误码。