查询插件列表
功能介绍
查询插件列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/marketplace/extension/extensionquery
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
filters |
是 |
Array of FilterSnake objects |
过滤字段 |
|
flags |
是 |
Integer |
插件flag;通过传递flag参数来进行过滤或其他操作。flag的基础数字是2\4\8\16;传递的参数只能是这四个数字加法组合而成数字 利用它们之间二进制的运算获取的值进行其他操作.比如6=0110=0010+0100也就是2和4的集合flags |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
criteria |
否 |
Array of CriteriaSnake objects |
过滤集合 |
|
page_number |
是 |
Long |
页码 |
|
page_size |
是 |
Long |
分页大小 |
|
sort_by |
否 |
Long |
排序字段.
枚举值：
|
|
sort_order |
否 |
Long |
排序顺序.
枚举值：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
filter_type |
否 |
Integer |
过滤类型
枚举值：
|
|
value |
否 |
String |
过滤类型对应字段名称 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
results |
Array of ExtensionQueryResult objects |
插件列表查询结果集合 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
extensions |
Array of ExtensionAllSnake objects |
插件列表集合 |
|
result_metadata |
Array of ResultMetadataSnake objects |
结果元数据集合 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
extension_id |
String |
插件id |
|
extension_name |
String |
插件名称 |
|
display_name |
String |
插件显示名称 |
|
flags |
Integer |
插件flag;通过传递flag参数来进行过滤或其他操作。flag的基础数字是2\4\8\16;传递的参数只能是这四个数字加法组合而成的数字 利用它们之间二进制的运算获取的值进行其他操作.比如6=0110=0010+0100也就是2和4的集合flags |
|
last_updated |
String |
更新时间 |
|
published_date |
String |
上传时间 |
|
release_date |
String |
发布时间 |
|
short_description |
String |
插件描述 |
|
tags |
Array of strings |
插件标签 |
|
tag_all_list |
Array of strings |
所有标签 |
|
publisher |
PublisherSnake object |
- |
|
arch |
Array of strings |
系统架构 |
|
target |
String |
安装目标 |
|
categories |
Array of strings |
插件分类 |
|
category_all_list |
Array of strings |
全部分类列表 |
|
publish_manager |
PublisherSnake object |
- |
|
status |
String |
插件状态
枚举值：
|
|
validate_status |
String |
插件审核状态
枚举值：
|
|
install_count |
Integer |
下载量 |
|
average_star |
Number |
平均评星值 |
|
identifier |
String |
插件唯一标识内部插件市场保留 |
|
support_os |
Array of strings |
插件支持的操作系统 |
|
support_ide |
Integer |
插件支持的ide |
|
support_ide_info |
String |
插件支持的ide名称 |
|
versions |
Array of ExtensionVersionSnake objects |
插件版本集合 |
|
validate_result |
String |
插件审核结果 |
|
extension_statistics |
ExtensionStatistics object |
- |
|
preview |
Boolean |
是否支持预览 |
|
ext_info |
ExtensionExternalInfo object |
- |
|
platform |
String |
安装目标 |
|
check_result |
CheckResult object |
- |
|
gray_version_count |
Integer |
灰度版本数量 |
|
extension_owner |
String |
插件作者 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
publisher_id |
String |
发布者id |
|
publisher_name |
String |
发布者名称 |
|
display_name |
String |
发布者展示名 |
|
publisher_status |
String |
插件作者状态
枚举值：
|
|
|
String |
发布者邮箱 |
|
web_url |
String |
网页url |
|
open |
Boolean |
是否开源 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
插件版本id |
|
version |
String |
插件版本号 |
|
version_ranking |
Long |
版本排序 |
|
status |
String |
插件版本状态
枚举值：
|
|
version_status |
String |
插件状态
枚举值：
|
|
asset_uri |
String |
资源文件url |
|
last_updated |
String |
更新时间 |
|
files |
Array of ExtensionFileSnake objects |
插件文件集合 |
|
validate_message |
String |
插件审核信息 |
|
version_validate_status |
String |
插件审核状态
枚举值：
|
|
display_name |
String |
插件展示名称 |
|
description |
String |
插件描述 |
|
min_ide_version |
String |
插件支持ide版本 |
|
max_ide_version |
String |
支持的最大版本 |
|
version_date |
String |
发布时间 |
|
preview |
Boolean |
是否预览 |
|
extension_pack |
String |
包含插件列表 |
|
extension_dependencies |
String |
依赖插件列表 |
|
created_at |
String |
创建时间 |
|
support_ide |
Integer |
支持的ide编码 |
|
repo_url |
String |
插件包源码仓 |
|
help_page |
String |
帮助页面 |
|
website |
String |
产品首页 |
|
issue_link |
String |
问题链接 |
|
asset_size |
Long |
插件大小 |
|
depends |
Array of strings |
依赖插件 |
|
property_list |
Array of CodeArtsIDEOnlineExtensionVersionProperty objects |
CodeArtsIDEOnline插件版本参数 |
|
uploader |
String |
版本发布者 |
|
extension_id |
String |
插件id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
id |
|
property_name |
String |
参数名 |
|
property_value |
String |
参数值 |
|
extension_version_id |
String |
插件版本id |
|
created_at |
String |
创建时间 |
|
updated_at |
String |
更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
extension_id |
String |
插件id |
|
repo_url |
String |
源码仓地址 |
|
help_page |
String |
帮助页面 |
|
website |
String |
产品首页 |
|
issue_link |
String |
问题链接 |
|
show_previews |
Boolean |
是否支持预览 |
|
created_at |
String |
创建时间 |
|
updated_at |
String |
更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
解析状态 |
|
errors |
Array of CheckResultError objects |
检查插件错误结果集 |
|
extension_version_compare |
String |
插件版本信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metadata_type |
String |
元数据类型 |
|
metadata_items |
Array of Map<String,Object> objects |
元数据列表 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
查询插件列表，每页显示20条插件。
POST https://{endpoint}/v1/marketplace/extension/extensionquery
{
"filters" : [ {
"page_number" : 1,
"page_size" : 20
} ],
"flags" : 8
}响应示例
状态码： 200
successful operation
{
"results" : [ {
"extensions" : [ {
"extension_id" : "d45648941sadsadsa_hdsa",
"extension_name" : "plugin_for_CodeArtsIDEOnline",
"display_name" : "backgroudcolor_setting",
"flags" : 8,
"last_updated" : "2022-08-31 00:00:00",
"published_date" : "2022-08-29 00:00:00",
"release_date" : "2022-09-06 00:00:00",
"short_description" : "插件的简要描述",
"tags" : [ "color", "extention" ],
"tag_all_list" : [ "color", "extension", "enhancer" ],
"publisher" : {
"publisher_id" : 123456,
"publisher_name" : "code-huawei",
"display_name" : "color-modify",
"publisher_status" : "VERIFIED",
"email" : "xxx@huawei.com",
"web_url" : "www.xxx.huawei.com",
"open" : true
},
"arch" : [ "x86", "arm" ],
"target" : "CodeArts IDE Online",
"categories" : [ "backgroud", "color" ],
"category_all_list" : [ "backgroud", "color", "script" ],
"publish_manager" : {
"publisher_id" : 123456,
"publisher_name" : "code-huawei",
"display_name" : "color-modify",
"publisher_status" : "VERIFIED",
"email" : "xxx@huawei.com",
"web_url" : "www.xxx.huawei.com",
"open" : true
},
"status" : "NORMAL",
"validate_status" : "NONE",
"install_count" : 5000,
"average_star" : 4.6,
"identifier" : "marketplace_plugin",
"support_os" : [ "win", "mac os", "linux" ],
"support_ide" : 3,
"support_ide_info" : "CodeArts IDE Online",
"versions" : [ {
"id" : "d45648132313",
"version" : "version_one",
"version_ranking" : 10000,
"status" : "PUBLISHED",
"version_status" : "PUBLISHED",
"asset_uri" : "www.example.com",
"last_updated" : "2022-08-31 00:00:00"
} ],
"extension_statistics" : {
"install" : 10000,
"stars" : 5
},
"preview" : false,
"ext_info" : {
"extension_id" : "d45648941sadsadsa_hdsa",
"repo_url" : "www.xxxcodehub.com",
"help_page" : "www.help.page.com",
"website" : "www.index.com",
"issue_link" : "www.problem.com",
"show_previews" : false
},
"platform" : "/opt/**",
"check_result" : {
"status" : "success"
},
"extension_owner" : "huaweistaff"
} ],
"result_metadata" : [ {
"metadata_type" : ".ts",
"metadata_items" : [ {
"key" : "value"
}, {
"uuid" : "uuid"
} ]
} ]
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
successful operation |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
