ListApiPlugins - 查询API插件列表

查询API插件列表。

调试

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

授权信息

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

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

请求参数

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

实例 ID

024f8cf0-c842-4c01-b74b-c8667e4579c7
UuidsJsonstring

API 插件唯一标识列表

["d17d5bfa-4972-4389-9718-f9602edabe48"]
PageNumberinteger

页号

1
PageSizeinteger

每页显示的条数

10

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码

200
Codestring

接口状态码

OK
Messagestring

接口提示消息

Success
RequestIdstring

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true
ApiPluginsarray<object>

API 插件列表

ApiPluginobject

API 插件配置

DraftedConfigJsonstring

草稿状态配置

{ "description": "测试-2", "functionMeta": { "failoverRegionWeight": 0.5, "functionMetaId": "a9127136087e4172b31b8f400430d63b", "functionName": "yongyu-stream-2", "regionId": "cn-hangzhou" }, "inputParams": [{ "debugValue": "1112", "description": "测试", "name": "test", "required": false, "type": "String", "valueSource": "Var" }], "name": "测试插件01", "outputParams": [{ "description": "直接返回API结果,并作为提示词输入给模型", "name": "result", "type": "String" }], "timeout": 5, "transitionContent": "稍等,和您确认下信息。", "type": "Function" }
Statusstring

状态。

  • Drafted 草稿
  • Published 已发布
  • PublishedAndEdited 已发布(已编辑)
Drafted
Typestring

类型

枚举值:
  • FunctionFunction
Function
PublishedConfigJsonstring

发布配置

{ "description": "发布-2", "functionMeta": { "failoverRegionWeight": 0.5, "functionMetaId": "c4af5815daaa485bb8118be6b2f14058", "functionName": "yongyu-stream-2", "regionId": "cn-hangzhou" }, "inputParams": [{ "debugValue": "111", "description": "发布", "name": "test", "required": false, "type": "String", "valueSource": "Var" }], "name": "发布插件", "outputParams": [{ "description": "直接返回API结果,并作为提示词输入给模型", "name": "result", "type": "String" }], "timeout": 5, "transitionContent": "稍等,和您确认下信息。", "type": "Function" }
Uuidstring

插件唯一标识

e1a3c448-20cf-4586-8aa2-4cdca75f7c20
Descriptionstring

描述信息。

这个插件是用来xxx.....
GmtCreatelong

创建时间。

1666230851000
InstanceIdstring

实例 ID

7c0e5b5e-a839-4999-8301-2c7d07a1f16f
GmtModifiedlong

更新时间

1641891940000
Namestring

插件名称

这是一个插件
PageSizeinteger

每页展示的条数

10
PageNumberinteger

页号

1
TotalCountlong

总条数

100

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "ApiPlugins": [
    {
      "DraftedConfigJson": {
        "description": "测试-2",
        "functionMeta": {
          "failoverRegionWeight": 0.5,
          "functionMetaId": "a9127136087e4172b31b8f400430d63b",
          "functionName": "yongyu-stream-2",
          "regionId": "cn-hangzhou"
        },
        "inputParams": [
          {
            "debugValue": 1112,
            "description": "测试",
            "name": "test",
            "required": false,
            "type": "String",
            "valueSource": "Var"
          }
        ],
        "name": "测试插件01",
        "outputParams": [
          {
            "description": "直接返回API结果,并作为提示词输入给模型",
            "name": "result",
            "type": "String"
          }
        ],
        "timeout": 5,
        "transitionContent": "稍等,和您确认下信息。",
        "type": "Function"
      },
      "Status": "Drafted",
      "Type": "Function",
      "PublishedConfigJson": {
        "description": "发布-2",
        "functionMeta": {
          "failoverRegionWeight": 0.5,
          "functionMetaId": "c4af5815daaa485bb8118be6b2f14058",
          "functionName": "yongyu-stream-2",
          "regionId": "cn-hangzhou"
        },
        "inputParams": [
          {
            "debugValue": 111,
            "description": "发布",
            "name": "test",
            "required": false,
            "type": "String",
            "valueSource": "Var"
          }
        ],
        "name": "发布插件",
        "outputParams": [
          {
            "description": "直接返回API结果,并作为提示词输入给模型",
            "name": "result",
            "type": "String"
          }
        ],
        "timeout": 5,
        "transitionContent": "稍等,和您确认下信息。",
        "type": "Function"
      },
      "Uuid": "e1a3c448-20cf-4586-8aa2-4cdca75f7c20",
      "Description": "这个插件是用来xxx.....",
      "GmtCreate": 1666230851000,
      "InstanceId": "7c0e5b5e-a839-4999-8301-2c7d07a1f16f",
      "GmtModified": 1641891940000,
      "Name": "这是一个插件"
    }
  ],
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 100
}

错误码

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