查询执行动作列表
功能介绍
该接口用于查询工具下的执行动作列表。
调用方法
请参见如何调用API。
URI
GET https://aiae.appstage.myhuaweicloud.com/v1/workflow-adapter-open/connectors/{connector_id}/actions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
connector_id |
是 |
String |
参数解释: 工具ID,进入AI原生应用引擎,在左侧导航栏选择“Agent编排中心 > 我的工具”,在工具列表中复制工具ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字以及“-”组成,且长度为36个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 偏移量。 约束限制: 不涉及。 取值范围: 正整数。 默认取值: 0。 |
|
limit |
否 |
Integer |
参数解释: 分页每页的条目数量。 约束限制: 不涉及。 取值范围: 1-1000的整数。 默认取值: 10。 |
|
keyword |
否 |
String |
参数解释: 查询关键字。 约束限制: 支持中英文、数字、下划线(_),1-50个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Authorization |
是 |
String |
参数解释: 鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释: 执行动作总数。 取值范围: 不涉及。 |
|
list |
Array of list objects |
参数解释: 执行动作信息列表。 取值范围: 不涉及。 |
|
pageNum |
Integer |
参数解释: 当前页。 取值范围: 不涉及。 |
|
pageSize |
Integer |
参数解释: 每页的数量。 取值范围: 不涉及。 |
|
size |
Integer |
参数解释: 当前页的数量。 取值范围: 不涉及。 |
|
startRow |
Integer |
参数解释: 当前页面第一个元素在数据库中的行号。 取值范围: 不涉及。 |
|
endRow |
Integer |
参数解释: 当前页面最后一个元素在数据库中的行号。 取值范围: 不涉及。 |
|
pages |
Integer |
参数解释: 总页数。 取值范围: 不涉及。 |
|
prePage |
Integer |
参数解释: 前一页。 取值范围: 不涉及。 |
|
nextPage |
Integer |
参数解释: 后一页。 取值范围: 不涉及。 |
|
isFirstPage |
Boolean |
参数解释: 是否为第一页。 取值范围: 不涉及。 |
|
isLastPage |
Boolean |
参数解释: 是否为最后一页。 取值范围: 不涉及。 |
|
hasPreviousPage |
Boolean |
参数解释: 是否有前一页。 取值范围: 不涉及。 |
|
hasNextPage |
Boolean |
参数解释: 是否有下一页。 取值范围: 不涉及。 |
|
navigatePages |
Integer |
参数解释: 工具总数。 取值范围: 不涉及。 |
|
navigatepageNums |
Array of integers |
参数解释: 所有导航页号。 取值范围: 不涉及。 |
|
navigateFirstPage |
Integer |
参数解释: 导航页上一页。 取值范围: 不涉及。 |
|
navigateLastPage |
Integer |
参数解释: 导航页下一页。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 执行动作ID。 取值范围: 只由英文字母、数字以及“-”组成,且长度为36个字符。 |
|
name |
String |
参数解释: 执行动作名称。 取值范围: 只能由中英文、数字、下划线、中划线、英文小括号组成,只能使用中英文以及数字开头,且长度不能超过32个字符。 |
|
description |
String |
参数解释: 执行动作描述。 取值范围: 只能包含中英文、数字、下划线、中划线、空格及,.?:;"':;“”‘’,。?、()()/@!!*%#等,且长度不能超过256个字符。 |
|
connector_id |
String |
参数解释: 执行动作所属工具ID。 取值范围: 只由英文字母、数字以及“-”组成,且长度为36个字符。 |
|
english_name |
String |
参数解释: 执行动作英文名称。 取值范围: 只能由英文、数字、下划线、中划线、英文小括号组成,只能使用英文以及数字开头,且长度不能超过32个字符。 |
|
created_time |
String |
参数解释: 创建时间。 取值范围: 不涉及。 |
|
update_time |
String |
参数解释: 更新时间。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
请求示例
无
响应示例
状态码:200
成功。
{
"data" : {
"total" : 100,
"list" : [ {
"id" : "uuid",
"name" : "example name1",
"description" : "example description",
"english_name" : "english example name1",
"connector_id" : "uuid",
"created_time" : "2025-02-06T00:00:00.000+00:00",
"updated_time" : "2025-02-06T00:00:00.000+00:00"
}, {
"id" : "uuid",
"name" : "example name2",
"description" : "example description",
"english_name" : "english example name2",
"connector_id" : "uuid",
"created_time" : "2025-02-06T00:00:00.000+00:00",
"updated_time" : "2025-02-06T00:00:00.000+00:00"
} ],
"pageNum" : 1,
"pageSize" : 10,
"size" : 10,
"startRow" : 1,
"endRow" : 10,
"pages" : 2,
"prePage" : 0,
"nextPage" : 2,
"isFirstPage" : true,
"isLastPage" : false,
"hasPreviousPage" : false,
"hasNextPage" : true,
"navigatePages" : 8,
"navigatepageNums" : [ 1, 2 ],
"navigateFirstPage" : 1,
"navigateLastPage" : 2
}
}
状态码:500
服务器内部错误或三方服务器内部错误。
{
"error_code" : "AIAE.22009001",
"error_msg" : "Internal Server Error."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功。 |
|
500 |
服务器内部错误或三方服务器内部错误。 |
错误码
请参见错误码。