文档首页/ 应用平台 AppStage/ API参考/ API/ 应用中心/ 查询工具详情
更新时间：2025-08-04 GMT+08:00
查看PDF
分享

查询工具详情

功能介绍

该接口用于查询工具详情。

调用方法

请参见如何调用API。

URI

GET https://aiae.appstage.myhuaweicloud.com/v1/workflow-adapter-open/connectors/{connector_id}

表1 路径参数

参数

是否必选

参数类型

描述

connector_id

是

String

参数解释：

工具ID，进入AI原生应用引擎，在左侧导航栏选择“Agent编排中心 > 我的工具”，在工具列表中复制工具ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字以及“-”组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

参数解释：

鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释：

工具ID。

取值范围：

只由英文字母、数字以及“-”组成，且长度为36个字符。

name

String

参数解释：

工具名称。

取值范围：

支持中英文、数字、下划线（_）、中划线（-）、小括号（）、空格，2-50个字符，以中英文、数字开头。

description

String

参数解释：

工具描述。

取值范围：

只能包含英文、中文、数字、下划线、中划线、空格及,，。.()（） ;；:、

connector_id

String

参数解释：

执行动作对应的工具ID。

取值范围：

只由英文字母、数字以及“-”组成，且长度为36个字符。

connector_version

String

参数解释：

工具的版本号。

取值范围：

正整数。

created_time

String

参数解释：

创建时间。

取值范围：

不涉及。

updated_time

String

参数解释：

修改时间。

取值范围：

不涉及。

test_result

String

参数解释：

最近一次测试结果。

取值范围：

不涉及。

swagger

Object

参数解释：

swagger文档（只包含基本信息+认证信息）。

取值范围：

不涉及。

definition

Object

参数解释：

操作or触发器的详细定义。

取值范围：

不涉及。

operation_id

String

参数解释：

执行动作ID。

取值范围：

正整数。

category

String

参数解释：

分类。

取值范围：

不涉及。

action_type

String

参数解释：

执行动作的类型。

取值范围：

枚举值：

  • api：接口类型

  • custom_function：函数类型

  • flow_action：流类型

visibility

String

参数解释：

标记动作在流编排是否可见。

取值范围：

不涉及。

english_name

String

参数解释：

执行动作英文名称。

取值范围：

不涉及。

状态码：500

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

请求示例

无

响应示例

状态码：200

成功。

{
  "data" : {
    "id" : "1234567-1234-1234-1234-1234-123451234512",
    "type" : "swagger",
    "name" : "example tool",
    "description" : "example description",
    "icon" : "base64 string",
    "created_time" : "2025-02-06T00:00:00.000+00:00",
    "updated_time" : "2025-02-06T00:00:00.000+00:00",
    "status" : "released",
    "swagger" : {
      "security" : [ ],
      "basePath" : "/",
      "host" : "example.com",
      "schemas" : [ "https" ],
      "securityDefinitions" : { },
      "swagger" : "2.0",
      "info" : {
        "x-can-modify-host-address" : "false",
        "description" : "example description",
        "x-cdm-visibility" : false,
        "title" : "example tool",
        "version" : "1.0.0",
        "x-hw-color" : "#14a8ff",
        "x-hw-icon" : "icon-huawei-default-5"
      }
    },
    "auth_content" : { },
    "version" : "1",
    "category" : null,
    "need_auth" : "false",
    "auth_id" : null,
    "action_count" : 2,
    "trigger_count" : 0,
    "provider_name" : null,
    "release_version" : null,
    "favorite" : null,
    "connector_type" : "PRIVATE",
    "connector_status" : "OFFBOARD"
  }
}

状态码：500

服务器内部错误或三方服务器内部错误。

{
  "error_code" : "AIAE.22009001",
  "error_msg" : "Internal Server Error."
}

状态码

状态码

描述

200

成功。

500

服务器内部错误或三方服务器内部错误。

错误码

请参见错误码。

父主题： 应用中心

相关文档