ListApiPlugins-阿里云帮助中心

Lists API plugins.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:ListApiPlugins

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	024f8cf0-c842-4c01-b74b-c8667e4579c7
UuidsJson	string	No	API plugin unique identifiers	["d17d5bfa-4972-4389-9718-f9602edabe48"]
PageNumber	integer	Yes	Page number	1
PageSize	integer	Yes	Number of entries per page	10

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
Code	string	API status code	OK
Message	string	API prompt message	Success
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates success	true
ApiPlugins	array<object>	API plugin list
	object	API plugin configuration
DraftedConfigJson	string	Draft configuration	{ "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	string	Status. Drafted Published PublishedAndEdited Valid values: Drafted : Drafted Published : Published PublishedAndEdited : PublishedAndEdited	Drafted
Type	string	Type Valid values: Function : Function	Function
PublishedConfigJson	string	Published configuration	{ "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	string	Unique plugin identifier	e1a3c448-20cf-4586-8aa2-4cdca75f7c20
Description	string	Description.	这个插件是用来xxx.....
GmtCreate	integer	Creation time.	1666230851000
InstanceId	string	Instance ID	7c0e5b5e-a839-4999-8301-2c7d07a1f16f
GmtModified	integer	Update time	1641891940000
Name	string	Plugin name	这是一个插件
PageSize	integer	Number of entries displayed per page	10
PageNumber	integer	Page number	1
TotalCount	integer	Total number of entries	100

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "ApiPlugins": [
    {
      "DraftedConfigJson": "{\n\t\"description\": \"测试-2\",\n\t\"functionMeta\": {\n\t\t\"failoverRegionWeight\": 0.5,\n\t\t\"functionMetaId\": \"a9127136087e4172b31b8f400430d63b\",\n\t\t\"functionName\": \"yongyu-stream-2\",\n\t\t\"regionId\": \"cn-hangzhou\"\n\t},\n\t\"inputParams\": [{\n\t\t\"debugValue\": \"1112\",\n\t\t\"description\": \"测试\",\n\t\t\"name\": \"test\",\n\t\t\"required\": false,\n\t\t\"type\": \"String\",\n\t\t\"valueSource\": \"Var\"\n\t}],\n\t\"name\": \"测试插件01\",\n\t\"outputParams\": [{\n\t\t\"description\": \"直接返回API结果，并作为提示词输入给模型\",\n\t\t\"name\": \"result\",\n\t\t\"type\": \"String\"\n\t}],\n\t\"timeout\": 5,\n\t\"transitionContent\": \"稍等，和您确认下信息。\",\n\t\"type\": \"Function\"\n}",
      "Status": "Drafted",
      "Type": "Function",
      "PublishedConfigJson": "{\n\t\"description\": \"发布-2\",\n\t\"functionMeta\": {\n\t\t\"failoverRegionWeight\": 0.5,\n\t\t\"functionMetaId\": \"c4af5815daaa485bb8118be6b2f14058\",\n\t\t\"functionName\": \"yongyu-stream-2\",\n\t\t\"regionId\": \"cn-hangzhou\"\n\t},\n\t\"inputParams\": [{\n\t\t\"debugValue\": \"111\",\n\t\t\"description\": \"发布\",\n\t\t\"name\": \"test\",\n\t\t\"required\": false,\n\t\t\"type\": \"String\",\n\t\t\"valueSource\": \"Var\"\n\t}],\n\t\"name\": \"发布插件\",\n\t\"outputParams\": [{\n\t\t\"description\": \"直接返回API结果，并作为提示词输入给模型\",\n\t\t\"name\": \"result\",\n\t\t\"type\": \"String\"\n\t}],\n\t\"timeout\": 5,\n\t\"transitionContent\": \"稍等，和您确认下信息。\",\n\t\"type\": \"Function\"\n}",
      "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.