查询执行动作详情
功能介绍
该接口用于查询执行动作详情。
调用方法
请参见如何调用API。
URI
GET https://aiae.appstage.myhuaweicloud.com/v1/workflow-adapter-open/connectors/{connector_id}/actions/{action_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
connector_id |
是 |
String |
参数解释： 工具ID，进入AI原生应用引擎，在左侧导航栏选择“Agent编排中心 > 我的工具”，在工具列表中复制工具ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字以及“-”组成，且长度为36个字符。 默认取值： 不涉及。 |
|
action_id |
是 |
String |
参数解释： 执行动作ID，进入AI原生应用引擎，在左侧导航栏选择“Agent编排中心 > 我的工具”，在工具列表中复制执行动作ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字以及“-”组成，且长度为36个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Authorization |
是 |
String |
参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 执行动作ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 |
|
type |
String |
参数解释： 执行动作类型。 取值范围：
|
|
name |
String |
参数解释： 执行动作名称。 取值范围： 支持中英文、数字、下划线（_）、中划线（-）、小括号（）、空格，2-50个字符，以中英文、数字开头。 |
|
description |
String |
参数解释： 执行动作描述。 取值范围： 只能包含英文、中文、数字、下划线、中划线、空格及,，。.()（） ;；:、 |
|
icon |
String |
参数解释： 执行动作图标。 取值范围： 合法的base64编码。 |
|
created_time |
String |
参数解释： 执行动作创建时间。 取值范围： 不涉及。 |
|
updated_time |
String |
参数解释： 执行动作更新时间。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 工具状态。 取值范围：
|
|
swagger |
Object |
参数解释： 执行动作的swagger信息。 取值范围： 不涉及。 |
|
auth_content |
String |
参数解释： 安全认证配置内容。 取值范围： 不涉及。 |
|
version |
String |
参数解释： 工具版本。 取值范围： 不涉及。 |
|
category |
String |
参数解释： 工具类别。 取值范围： 不涉及。 |
|
need_auth |
Boolean |
参数解释： 是否需要验证。 取值范围： 不涉及。 |
|
auth_id |
String |
参数解释： 认证配置ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 |
|
action_count |
String |
参数解释： 执行动作ID。 取值范围： 不涉及。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误信息。 取值范围： 不涉及。 |
请求示例
无
响应示例
状态码：200
成功。
{
"data" : {
"id" : "uuid",
"name" : "action name",
"description" : "example description",
"connector_id" : "connector id",
"connector_version" : "4",
"created_time" : "2025-02-06T12:00:05.000+00:00",
"updated_time" : "2025-02-06T12:00:05.000+00:00",
"test_result" : null,
"category" : null,
"swagger" : {
"/test" : {
"post" : {
"summary" : "action name",
"description" : "action description",
"operationId" : "uuid",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : false,
"schema" : {
"type" : "object",
"required" : [ "input" ],
"properties" : {
"input" : {
"type" : "string",
"format" : "input",
"description" : "输入",
"default" : "",
"x-hw-visibility" : "none",
"x-hw-label" : "输入",
"x-hw-format" : "input",
"x-hw-select-options" : [ ],
"x-hw-default" : ""
}
}
},
"x-hw-body-required" : true
} ],
"responses" : {
"200" : {
"description" : "请求成功",
"headers" : { },
"schema" : {
"type" : "object",
"properties" : {
"output" : {
"type" : "string",
"format" : "input",
"description" : "输出",
"default" : "",
"x-hw-visibility" : "none",
"x-hw-label" : "输出",
"x-hw-format" : "input",
"x-hw-select-options" : [ ],
"x-hw-default" : ""
}
}
}
}
},
"x-hw-visibility" : "none",
"x-model" : {
"input-MappingConfig" : {
"rules" : [ ]
},
"input-is-model-mapping" : false,
"input-model" : { },
"output-MappingConfig" : {
"rules" : [ ]
},
"output-is-model-mapping" : false,
"output-model" : { }
}
}
}
},
"definition" : {
"id" : "uuid",
"name" : "action name",
"description" : "action description",
"type" : "action",
"is_include_required" : true,
"props" : {
"query" : { },
"path" : { },
"header" : { },
"form" : { },
"body" : {
"input" : {
"type" : "string",
"format" : "input",
"description" : "输入",
"default" : "",
"x-hw-visibility" : "none",
"x-hw-label" : "输入",
"x-hw-format" : "input",
"x-hw-select-options" : [ ],
"x-hw-default" : "",
"required" : true
}
},
"trigger" : { }
},
"props_present" : {
"body" : {
"type" : "object",
"required" : [ "input" ]
},
"body/input" : {
"type" : "string",
"format" : "input",
"description" : "输入",
"default" : "",
"x-hw-visibility" : "none",
"x-hw-label" : "输入",
"x-hw-format" : "input",
"x-hw-select-options" : [ ],
"x-hw-default" : "",
"required" : true
}
},
"response" : {
"200" : {
"props" : {
"header" : { },
"body" : {
"output" : {
"type" : "string",
"format" : "input",
"description" : "输出",
"default" : "",
"x-hw-visibility" : "none",
"x-hw-label" : "输出",
"x-hw-format" : "input",
"x-hw-select-options" : [ ],
"x-hw-default" : "",
"required" : false
}
},
"query" : null,
"path" : null,
"form" : null
},
"props_present" : {
"body/output" : {
"type" : "string",
"format" : "input",
"description" : "输出",
"default" : "",
"x-hw-visibility" : "none",
"x-hw-label" : "输出",
"x-hw-format" : "input",
"x-hw-select-options" : [ ],
"x-hw-default" : "",
"required" : false
},
"header" : {
"type" : "object",
"description" : "响应头",
"x-hw-label" : "响应头"
},
"body" : {
"type" : "object",
"description" : "响应体",
"x-hw-label" : "响应体"
}
}
}
},
"polling_config" : null
},
"operation_id" : "uuid",
"action_type" : "api",
"visibility" : "none",
"english_name" : "example english name"
}
}
状态码：500
服务器内部错误或三方服务器内部错误。
{
"error_code" : "AIAE.22009001",
"error_msg" : "Internal Server Error."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功。 |
|
500 |
服务器内部错误或三方服务器内部错误。 |
错误码
请参见错误码。
