ListToolsets - 批量查询工具集

批量查询工具集

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
devs:ListToolsetslist
*全部资源
*

请求语法

GET /2023-07-14/toolsets HTTP/1.1

请求参数

名称类型必填描述示例值
labelSelectorarray

利用实体的 labels 字段进行筛选。精确匹配 labelSelector 数组中的所有条件,不同条件之间是“且”的关系

string

labelSelector 中的一条筛选条件,格式为${key}=${value}

label_key1=value1
pageNumberlong

当前页码,默认为 1。页码从 1 开始。

1
pageSizelong

每页大小,默认为 100。取值范围 1~100

10
keywordstring

模糊搜索关键词。仅支持实体的 name 字段,且大小写不敏感

demo

返回参数

名称类型描述示例值
object

查询的分页结果

pageNumberlong

当前页码

1
pageSizelong

每页大小

10
totalCountlong

查询到的结果数量

10
dataarray

查询的资源实体列表

dataToolset

查询的一个满足条件的项目实体

示例

正常返回示例

JSON格式

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 10,
  "data": [
    {
      "generation": 1,
      "uid": "1455541096***548",
      "kind": "Toolset",
      "name": "my-toolset",
      "createdTime": "2021-11-19T09:34:38Z",
      "description": "test-description",
      "spec": {
        "schema": {
          "detail": "",
          "type": "OpenAPI"
        },
        "authorization": {
          "authConfig": {
            "key": ""
          },
          "type": "apiKey"
        },
        "authConfig": {
          "type": "APIKey",
          "parameters": {
            "apiKeyParameter": {
              "encrypted": true,
              "in": "header",
              "value": "mock_value",
              "key": "Authorization"
            }
          }
        }
      },
      "labels": {
        "key": "key=value"
      },
      "status": {
        "phase": "Installed",
        "outputs": {
          "urls": {
            "internetUrl": "",
            "intranetUrl": ""
          },
          "openApiTools": [
            {
              "toolId": "",
              "path": "",
              "method": "",
              "toolName": ""
            }
          ],
          "mcpServerConfig": {
            "headers": {
              "key": ""
            },
            "transportType": "",
            "url": ""
          },
          "tools": [
            {
              "inputSchema": {
                "test": "test",
                "test2": 1
              },
              "name": "demo-tool",
              "description": "Here is an example"
            }
          ],
          "functionArn": ""
        },
        "observedTime": "",
        "observedGeneration": 0
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。