文档首页/ 应用平台 AppStage/ API参考/ API/ 应用中心/ 查询我的工具页面的工具连接器列表
更新时间：2025-03-12 GMT+08:00
查看PDF
分享

查询我的工具页面的工具连接器列表

功能介绍

该接口用于查询我的工具页面的工具连接器列表。

调用方法

请参见如何调用API。

URI

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

表1 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量。

约束限制：

不涉及。

取值范围：

正整数。

默认取值：

0。

limit

否

Integer

参数解释：

分页每页的条目数量。

约束限制：

不涉及。

取值范围：

1-1000的整数。

默认取值：

10。

keyword

否

String

参数解释：

查询关键字。

约束限制：

支持中英文、数字、下划线（_），1-50个字符。

取值范围：

不涉及。

默认取值：

不涉及。

status

否

String

参数解释：

工具状态。

约束限制：

不涉及。

取值范围：

  • OFFBOARD：待上架

  • ONBOARD：已上架

  • APPROVING：审批中

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

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

参数解释：

导航页下一页。

取值范围：

不涉及。
表4 list

参数

参数类型

描述

id

String

参数解释：

工具ID。

取值范围：

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

name

String

参数解释：

工具名称。

取值范围：

只能由中英文、数字、下划线、中划线、英文小括号组成，只能使用中英文以及数字开头，且长度不能超过32个字符。

description

String

参数解释：

工具描述。

取值范围：

只能包含中英文、数字、下划线、中划线、空格及,.?:;"'：；“”‘’，。？、（）()/@!！*%#等，且长度不能超过256个字符。

icon

String

参数解释：

工具图标。

取值范围：

格式正确的base64编码。

type

String

参数解释：

工具类别。

取值范围：

PRIVATE表示用户自创建工具、SUBSCRIBED表示从资产中心订阅的工具、ONBOARD表示已经上架到资产中心的工具、PUBLIC表示平台预置工具。

status

String

参数解释：

工具状态。

取值范围：

  • OFFBOARD：待上架

  • ONBOARD：已上架

  • APPROVING：审批中

created_time

String

参数解释：

创建时间。

取值范围：

不涉及。

approval_id

String

参数解释：

审批ID。

取值范围：

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

asset_id

String

参数解释：

工具对应的资产中心ID。

取值范围：

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

version

String

参数解释：

工具版本。

取值范围：

正整数。

auth_content

String

参数解释：

安全认证配置内容。

取值范围：

不涉及。

状态码：500

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

请求示例

无

响应示例

状态码：200

成功。

{
  "data" : {
    "total" : 100,
    "list" : [ {
      "id" : "uuid",
      "name" : "example name1",
      "description" : "example description",
      "icon" : "base64 string",
      "type" : "PRIVATE",
      "status" : "OFFBOARD",
      "created_time" : "2025-02-06T00:00:00.000+00:00",
      "approval_id" : null,
      "asset_id" : null,
      "version" : "3",
      "auth_content" : { }
    }, {
      "id" : "uuid",
      "name" : "example name2",
      "description" : "example description",
      "icon" : "base64 string",
      "type" : "PRIVATE",
      "status" : "OFFBOARD",
      "created_time" : "2025-02-06T00:00:00.000+00:00",
      "approval_id" : null,
      "asset_id" : null,
      "version" : "3",
      "auth_content" : {
        "auth_type" : "apiKey",
        "cdm_params_config" : {
          "cdmParams" : "String",
          "cdmVisibility" : false
        },
        "auth_dynamic" : { },
        "auth_info" : { },
        "auth_prop" : {
          "key" : {
            "format" : "password",
            "type" : "string",
            "required" : true
          }
        },
        "auth_config" : {
          "in" : "query",
          "name" : "key"
        },
        "host_config" : {
          "canModifyHostAddress" : false,
          "host" : "https://restapi.amap.com"
        }
      }
    } ],
    "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

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

错误码

请参见错误码。

父主题： 应用中心

相关文档