# 查询插件列表 - ListExtensions #### 功能介绍 在CodeArts IDE Online的插件市场中查看插件列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudIDE/doc?api=ListExtensions)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 当前API调用无需身份策略权限。 #### URI POST /v1/marketplace/extension/extensionquery #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释：** 通过调用IAM服务获取的用户Token（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 1\~100000。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | filters | 是 | Array of [FilterSnake] objects | **参数解释：** 过滤字段。 **约束限制：** 不涉及。 **取值范围：** 0\~255。 **默认取值：** 不涉及。 | | flags | 是 | Integer | **参数解释：** 插件flag，通过传递flag参数来进行过滤或其他操作。 **约束限制：** 基础数字是2\\4\\8\\16，传递的参数只能是这四个数字加法组合而成数字。 **取值范围：** 2\~30。 **默认取值：** 不涉及。 | 表3FilterSnake | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | criteria | 否 | Array of [CriteriaSnake] objects | **参数解释：** 过滤集合。 **约束限制：** 不涉及。 **取值范围：** 0\~255。 **默认取值：** 不涉及。 | | page_number | 是 | Long | **参数解释：** 页码。 **约束限制：** 不涉及。 **取值范围：** 1\~10000。 **默认取值：** 不涉及。 | | page_size | 是 | Long | **参数解释：** 分页大小。 **约束限制：** 不涉及。 **取值范围：** 1\~10000。 **默认取值：** 不涉及。 | | sort_by | 否 | Long | **参数解释：** 排序字段。 **约束限制：** 不涉及。 **取值范围：** - 1 修改日期 - 2 插件名称 - 3 插件作者名称 **默认取值：** 不涉及。 | | sort_order | 否 | Long | **参数解释：** 排序顺序。 **约束限制：** 不涉及。 **取值范围：** - 1 升序排序 - 2 降序排序 **默认取值：** 不涉及。 | 表4CriteriaSnake | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | filter_type | 否 | Integer | **参数解释：** 过滤类型。 **约束限制：** 不涉及。 **取值范围：** - 1：按照插件Tag过滤 - 2：按照diplayName过滤 - 3：按照publisherId过滤 - 4：按照插件ID过滤 - 5：按照插件分类过滤 - 7：按照作者名、插件名过滤 - 8：按照Target（客户端）过滤 - 10：按照关键字（客户端输入的）过滤 - 12：按照flags传入的值来进行过滤 - 13：按照flags传入的值来进行过滤 - 18：按照publisherName过滤 - 19：按照publisherDisplayName过滤 - 102：按照插件状态排除插件 - 103：按照插件状态过滤出插件 - 107：按照发布信息过滤 - 108：按照插件ids查询 **默认取值：** 不涉及。 | | value | 否 | String | **参数解释：** 过滤类型对应字段名称。 **约束限制：** 不涉及。 **取值范围：** 1\~255。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | results | Array of [ExtensionQueryResult] objects | **参数解释：** 插件列表查询结果集合。 **取值范围：** 0\~255。 | 表6ExtensionQueryResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | extensions | Array of [ExtensionAllSnake] objects | **参数解释：** 插件列表集合。 **取值范围：** 0\~255。 | | result_metadata | Array of [ResultMetadataSnake] objects | **参数解释：** 结果元数据集合。 **取值范围：** 0\~255。 | 表7ExtensionAllSnake | 参数 | 参数类型 | 描述 | |:---|:---|:---| | extension_id | String | **参数解释：** 插件ID。 **取值范围：** 0\~64。 | | extension_name | String | **参数解释：** 插件名称。 **取值范围：** 0\~255。 | | display_name | String | **参数解释：** 插件显示名称。 **取值范围：** 0\~255。 | | flags | Integer | **参数解释：** 插件flag，通过传递flag参数来进行过滤或其他操作。 **取值范围：** 2\~30。flag的基础数字是2\\4\\8\\16，传递的参数只能是这四个数字加法组合而成。 | | last_updated | String | **参数解释：** 更新时间。 **取值范围：** 正则表达式：yyyy-MM-dd HH:mm:ss | | published_date | String | **参数解释：** 上传时间。 **取值范围：** 正则表达式：yyyy-MM-dd HH:mm:ss。 | | release_date | String | **参数解释：** 发布时间。 **取值范围：** 正则表达式：yyyy-MM-dd HH:mm:ss。 | | short_description | String | **参数解释：** 插件描述。 **取值范围：** 长度为0\~1024。 | | tags | Array of strings | **参数解释：** 插件标签。 **取值范围：** 长度为0\~255。 | | tag_all_list | Array of strings | **参数解释：** 所有标签。 **取值范围：** 长度为0\~255。 | | publisher | [PublisherSnake] object | **参数解释：** 发布者。 **取值范围：** 不涉及。 | | arch | Array of strings | **参数解释：** 系统架构。 **取值范围：** 0\~255。 | | target | String | **参数解释：** 安装目标。 **取值范围：** 0\~255。 | | categories | Array of strings | **参数解释：** 插件分类。 **取值范围：** 0\~255。 | | category_all_list | Array of strings | **参数解释：** 全部分类列表。 **取值范围：** 0\~255。 | | publish_manager | [PublisherSnake] object | **参数解释：** 发布管理。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 插件状态。 **取值范围：** - INIT：上传插件的第一个版本 - NORMAL：插件有审核通过的版本 - OFFLINE：插件下线 - ABANDONED：插件上传废弃 - GRAYED：灰度插件 | | validate_status | String | **参数解释：** 插件审核状态。 **取值范围：** - NONE：插件审核结束 - VALIDATING：插件处于审核中 | | install_count | Integer | **参数解释：** 下载量。 **取值范围：** 0\~2147483647。 | | average_star | Number | **参数解释：** 平均评星值。 **取值范围：** 0\~5。 | | identifier | String | **参数解释：** 插件唯一标识，内部插件市场保留。 **取值范围：** 0\~255。 | | support_os | Array of strings | **参数解释：** 插件支持的操作系统。 **取值范围：** 0\~255。 | | support_ide | Integer | **参数解释：** 插件支持的ide。 **取值范围：** 0\~2147483647。 | | support_ide_info | String | **参数解释：** 插件支持的ide名称。 **取值范围：** 0\~255。 | | versions | Array of [ExtensionVersionSnake] objects | **参数解释：** 插件版本集合。 **取值范围：** 0\~255。 | | validate_result | String | **参数解释：** 插件审核结果。 **取值范围：** 0\~255。 | | extension_statistics | [ExtensionStatistics] object | **参数解释：** 插件扩展状态。 **取值范围：** 不涉及。 | | preview | Boolean | **参数解释：** 是否支持预览。 **取值范围：** - TRUE：支持预览。 - FALSE：不支持预览。 | | ext_info | [ExtensionExternalInfo] object | **参数解释：** 插件扩展信息。 **取值范围：** 不涉及。 | | platform | String | **参数解释：** 安装目标。 **取值范围：** 0\~255。 | | check_result | [CheckResult] object | **参数解释：** 检查结果。 **取值范围：** 不涉及。 | | gray_version_count | Integer | **参数解释：** 灰度版本数量。 **取值范围：** 0\~255。 | | extension_owner | String | **参数解释：** 插件作者。 **取值范围：** 0\~255。 | 表8PublisherSnake | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publisher_id | String | **参数解释：** 发布者ID。 **取值范围：** 0\~64 | | publisher_name | String | **参数解释：** 发布者名称。 **取值范围：** 0\~255 | | display_name | String | **参数解释：** 发布者展示名。 **取值范围：** 0\~255 | | publisher_status | String | **参数解释：** 插件作者状态。 **取值范围：** - DISABLED：验证不通过 - VERIFIED：验证通过 | | email | String | **参数解释：** 发布者邮箱。 **取值范围：** 0\~255 | | web_url | String | **参数解释：** 网址URL。 **取值范围：** 0\~255 | | open | Boolean | **参数解释：** 是否开源。 **取值范围：** - TRUE：插件为开源。 - FALSE：插件为非开源。 | 表9ExtensionVersionSnake | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 插件版本ID。 **取值范围：** 0\~255 | | version | String | **参数解释：** 插件版本号。 **取值范围：** 0\~255 | | version_ranking | Long | **参数解释：** 版本排序。 **取值范围：** 0\~2147483647 | | status | String | **参数解释：** 插件状态。 **取值范围：** - INIT：插件待发布 - VALIDATING：插件审核中 - REJECTED：插件审核被驳回 - PUBLISHED：插件发布上架 - OFFLINE：插件下线 - ABANDONED：插件废弃 - GRAY_INIT：插件灰度审核 - GRAYED：插件灰度发布 - GRAY_REJECTED：插件灰度被驳回 | | version_status | String | **参数解释：** 插件版本状态。 **取值范围：** - INIT：插件版本待发布 - VALIDATING：插件版本审核中 - REJECTED：插件版本审核被驳回 - PUBLISHED：插件版本上架 - OFFLINE：插件版本下线 - ABANDONED：插件版本被废弃 - GRAY_INIT：插件版本灰度审核 - GRAYED：插件版本灰度发布 - GRAY_REJECTED：插件版本灰度被驳回 | | asset_uri | String | **参数解释：** 资源文件URL。 **取值范围：** 0\~255 | | last_updated | String | **参数解释：** 更新时间。 **取值范围：** yyyy-MM-dd HH:mm:ss | | files | Array of [ExtensionFileSnake] objects | **参数解释：** 插件文件集合。 **取值范围：** 0\~255 | | validate_message | String | **参数解释：** 插件审核信息。 **取值范围：** 0\~4096 | | version_validate_status | String | **参数解释：** 插件审核状态。 **取值范围：** - NONE：插件没有处于审核状态 - UPLOADING：插件上传中 - VALIDATING：插件处于系统审核中 - OFFLINING：用户申请插件下线 - ONLINING：用户申请插件上线 - UMS_VALIDATING：插件处于发布商审核中 | | display_name | String | **参数解释：** 插件展示名称。 **取值范围：** 0\~255 | | description | String | **参数解释：** 插件描述。 **取值范围：** 0\~1000000 | | min_ide_version | String | **参数解释：** 插件支持IDE版本。 **取值范围：** 0\~255 | | max_ide_version | String | **参数解释：** 插件支持的最大版本。 **取值范围：** 0\~255 | | version_date | String | **参数解释：** 发布时间。 **取值范围：** yyyy-MM-dd HH:mm:ss | | preview | Boolean | **参数解释：** 插件预览。 **取值范围：** 不涉及 | | extension_pack | String | **参数解释：** 包含插件列表。 **取值范围：** 0\~1024 | | extension_dependencies | String | **参数解释：** 依赖插件列表。 **取值范围：** 0\~1024 | | created_at | String | **参数解释：** 创建时间。 **取值范围：** yyyy-MM-dd HH:mm:ss | | support_ide | Integer | **参数解释：** 支持的IDE编码。 **取值范围：** 0\~2147483647 | | repo_url | String | **参数解释：** 插件包源码仓。 **取值范围：** 0\~255 | | help_page | String | **参数解释：** 帮助页面。 **取值范围：** 0\~255 | | website | String | **参数解释：** 产品首页。 **取值范围：** 0\~255 | | issue_link | String | **参数解释：** 问题链接。 **取值范围：** 0\~255 | | asset_size | Long | **参数解释：** 插件大小。 **取值范围：** 0\~2147483647 | | depends | Array of strings | **参数解释：** 依赖插件。 **取值范围：** 0\~255 | | property_list | Array of [CodeArtsIDEOnlineExtensionVersionProperty] objects | **参数解释：** CodeArts IDE Online插件版本参数。 **取值范围：** 0\~255 | | uploader | String | **参数解释：** 版本发布者。 **取值范围：** 0\~64 | | extension_id | String | **参数解释：** 插件扩展ID。 **取值范围：** 0\~64 | 表10ExtensionFileSnake | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_type | String | **参数解释：** 资源类型。 **取值范围：** - Icons.Default：品牌标识 - PackageJson：配置文件 - Package：安装包 - Changelog：记录项目变更历史 - License：项目许可 | | source | String | **参数解释：** 资源地址。 **取值范围：** 不涉及 | 表11CodeArtsIDEOnlineExtensionVersionProperty | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 插件ID。 **取值范围：** 0\~10000。 | | property_name | String | **参数解释：** 参数名。 **取值范围：** 0\~10000。 | | property_value | String | **参数解释：** 参数值。 **取值范围：** 0\~10000。 | | extension_version_id | String | **参数解释：** 插件版本ID。 **取值范围：** 0\~255。 | | created_at | String | **参数解释：** 创建时间。 **取值范围：** yyyy-MM-dd HH:mm:ss。 | | updated_at | String | **参数解释：** 更新时间。 **取值范围：** yyyy-MM-dd HH:mm:ss。 | 表12ExtensionStatistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | install | Integer | **参数解释：** 下载量。 **取值范围：** 0\~2147483647。 | | stars | Double | **参数解释：** 评星。 **取值范围：** 0\~5。 | 表13ExtensionExternalInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | extension_id | String | **参数解释：** 插件ID。 **取值范围：** 0\~64。 | | repo_url | String | **参数解释：** 源码仓地址。 **取值范围：** 0\~255。 | | help_page | String | **参数解释：** 帮助页面。 **取值范围：** 0\~255。 | | website | String | **参数解释：** 产品首页。 **取值范围：** 0\~255。 | | issue_link | String | **参数解释：** 问题链接。 **取值范围：** 0\~255。 | | show_previews | Boolean | **参数解释：** 是否支持预览。 **取值范围：** - true：支持预览。 - false：不支持预览。 | | created_at | String | **参数解释：** 创建时间。 **取值范围：** yyyy-MM-dd HH:mm:ss。 | | updated_at | String | **参数解释：** 更新时间。 **取值范围：** yyyy-MM-dd HH:mm:ss。 | 表14CheckResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 解析状态。 **取值范围：** - INIT：上传初始化 - NORMAL：插件正式版本 - OFFLINE：插件下线 - ABANDONED：插件上传废弃 - GRAYED：灰度插件 | | errors | Array of [CheckResultError] objects | **参数解释：** 检查插件错误结果集。 **取值范围：** 0\~255。 | | extension_version_compare | String | **参数解释：** 插件版本信息。 **取值范围：** 0\~10000。 | 表15CheckResultError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 解析结果码。 **取值范围：** 0\~10000。 | | message | String | **参数解释：** 解析结果信息。 **取值范围：** 0\~255。 | 表16ResultMetadataSnake | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metadata_type | String | **参数解释：** 元数据类型。 **取值范围：** 0\~1000。 | | metadata_items | Array of Map\ objects | **参数解释：** 元数据列表。 **取值范围：** 0\~255。 | **状态码：401** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 不涉及。 | **状态码：403** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 不涉及。 | **状态码：404** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 不涉及。 | #### 请求示例 查询插件列表 ``` 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.xxx.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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。