查询插件所有版本信息
功能介绍
查询插件所有版本信息
调用方法
请参见如何调用API。
URI
GET /v1/{domain_id}/agent-plugin/query
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 租户ID,用户的domainId。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| plugin_name | 是 | String | 参数解释: 扩展插件名称。 约束限制: 仅支持输入大小写英文字母、数字、'-'、'_'。 取值范围: 1到50位字符。 默认取值: 不涉及。 |
| offset | 是 | String | 参数解释: 偏移量,表示从此偏移量开始查询需配合limit一起使用。 约束限制: 不涉及。 取值范围: offset大于等于0。 默认取值: 不涉及。 |
| limit | 是 | String | 参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 1到100。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| offset | Integer | 参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: offset大于等于0。 默认取值: 默认为0。 |
| limit | Integer | 参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
| total | Integer | 参数解释: 总条目数量。 取值范围: 大于等于0。 |
| data | Array of PluginBasicVO objects | 参数解释: 扩展插件列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| plugin_name | String | 参数解释: 扩展插件名称。 取值范围: 1到50位字符。 |
| display_name | String | 参数解释: 扩展插件名称。 取值范围: 不涉及。 |
| db_record_name | String | 参数解释: 插件记录展示名称。 取值范围: 不涉及。 |
| version | String | 参数解释: 扩展插件版本号。 取值范围: 不涉及。 |
| version_description | String | 参数解释: 扩展插件版本号说明。 取值范围: 不涉及。 |
| description | String | 参数解释: 扩展插件描述。 取值范围: 不涉及。 |
| version_attribution | String | 参数解释: 扩展插件版本属性。 取值范围:
|
| unique_id | String | 参数解释: 扩展插件唯一ID。 取值范围: 不涉及。 |
| op_user | String | 参数解释: 扩展插件最后更新人。 取值范围: 不涉及。 |
| op_time | String | 参数解释: 扩展插件最后更新时间。 取值范围: 不涉及。 |
| plugin_composition_type | String | 参数解释: 用于标识插件是否为多个step组成的组合插件。 取值范围:
|
| plugin_attribution | String | 参数解释: 扩展插件属性。 取值范围:
|
| workspace_id | String | 参数解释: 租户ID,用户的domainId。 取值范围: 32位字符,仅由数字和字母组成。 |
| business_type | String | 参数解释: 扩展插件业务类型。 取值范围:
|
| business_type_display_name | String | 参数解释: 扩展插件业务类型展示名称。 取值范围: 不涉及。 |
| maintainers | String | 参数解释: 扩展插件维护人。 取值范围: 不涉及。 |
| icon_url | String | 参数解释: 扩展插件图标地址。 取值范围: 不涉及。 |
| refer_count | Integer | 参数解释: 扩展插件被流水线引用次数。 取值范围: 不涉及。 |
| usage_count | Integer | 参数解释: 扩展插件被流水线使用次数。 取值范围: 不涉及。 |
| runtime_attribution | String | 参数解释: 运行属性。 取值范围:
|
| active | Integer | 参数解释: 扩展插件是否激活。 取值范围:
|
| version_state | String | 参数解释: 当前插件版本状态。 取值范围: 不涉及。 |
| publisher_unique_id | String | 参数解释: 发布商ID。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者名称。 取值范围: 不涉及。 |
| create_time | String | 参数解释: 创建时间。 取值范围: 不涉及。 |
| manifest_version | String | 参数解释: 插件版本标识符。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/query?plugin_name=fff&offset=0&limit=1 响应示例
状态码:200
OK
{
"offset" : 0,
"limit" : 1,
"total" : 1,
"data" : [ {
"plugin_name" : "fff",
"display_name" : "hhjk",
"version" : "0.0.1",
"version_description" : "",
"description" : "",
"version_attribution" : "formal",
"unique_id" : "d4d18039ac4248b68d38aca463a0c35a",
"op_user" : "devcloud_devcloud_h00485561_01",
"op_time" : "1699931374000",
"plugin_composition_type" : "multi",
"plugin_attribution" : "custom",
"workspace_id" : "ce8df55870164338a72d7e828a966a2a",
"business_type" : "Normal",
"business_type_display_name" : "通用",
"maintainers" : "[\"847a5317086c41798469d0868535943a\"]",
"icon_url" : "",
"refer_count" : null,
"usage_count" : null,
"runtime_attribution" : "agent",
"active" : 1
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
错误码
请参见错误码。