Querying the Basic Extension List

Function

This API is used to query the basic extension list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{domain_id}/relation/plugin/single

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
attribution	Yes	String	Definition: Extension attribute. Constraints: N/A Value range: official: extension published by the official party. published: extension published by the second party. Default value: N/A
offset	Yes	String	Definition: Offset where the query starts. This parameter must be used together with limit. Constraints: N/A Value range: The offset value must be no less than 0. Default value: N/A
limit	Yes	String	Definition: Number of records of each query. Constraints: N/A Value range: 1–100. Default value: N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
offset	Integer	Definition: Offset where the query starts. Value range: The offset value must be no less than 0.
limit	Integer	Definition: Number of records of each query. Value range: The value is no less than 0.
total	Integer	Definition: Total number of queried static rules. Value range: N/A
data	Array of data objects	Definition: Result set. Value range: N/A

**Table 5** data
Parameter	Type	Description
name	String	Definition: Unique identifier of the extension. Value range: N/A
display_name	String	Definition: The extension name displayed in the extension platform and pipeline. Value range: N/A
plugin_attribution	String	Definition: Whether the extension is an official one. Value range: N/A
icon_url	String	Definition: Icon URL. Value range: N/A
description	String	Definition: Extension description. Value range: N/A
publisher_id	String	Definition: Publisher ID. Value range: N/A
manifest_version	String	Definition: Version. Value range: N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugin/single?limit=10&offset=0&attribution=official

Example Responses

Status code: 200

{
  "offset" : 0,
  "limit" : 10,
  "total" : 3,
  "data" : [ {
    "name" : "official_shell_plugin",
    "display_name" : "Executing the Shell",
    "plugin_attribution" : "official",
    "icon_url" : "",
    "description" : "Used to run user shell commands.",
    "publisher_id" : null,
    "manifest_version" : "3"
  }, {
    "name" : "test_plugin_230725",
    "display_name" : "Testing the New Plug-in Process 2307251",
    "plugin_attribution" : "official",
    "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=test_plugin_230725-b7b10ddbbae14356ab16d649a43d7776-20210811-153521(WeLinkPC).png-ce8df55870164338a72d7e828a966a2a&icon_type=plugin",
    "description" : "Here is the description.",
    "publisher_id" : null,
    "manifest_version" : "3"
  }, {
    "name" : "official_git_clone",
    "display_name" : "official_git_clone",
    "plugin_attribution" : "official",
    "icon_url" : "",
    "description" : "Download the code library configured in the pipeline source.",
    "publisher_id" : null,
    "manifest_version" : null
  } ]
}