Skip to content

Latest commit

 

History

History
193 lines (167 loc) · 6.16 KB

get-plug-in-details-according-to-the-plug-in-code.md

File metadata and controls

193 lines (167 loc) · 6.16 KB

根据插件代码获取插件详细信息

请求方法/请求路径

GET /ms/openapi/api/apigw/v3/atoms/{atomCode}

资源描述

根据插件代码获取插件详细信息

输入参数说明

Path参数

参数名称 参数类型 必须 参数说明 默认值
atomCode string 插件代码

响应

HTTP代码 说明 参数类型
200 successful operation 数据返回包装模型AtomVersion

请求样例

curl -X GET '[请替换为API地址栏请求地址]'

HEADER样例

accept: application/json
Content-Type: application/json

返回样例-200

{
  "data" : {
    "versionContent" : "String",
    "flag" : true,
    "modifier" : "String",
    "description" : "String",
    "language" : "String",
    "yamlFlag" : true,
    "atomId" : "String",
    "atomStatus" : "String",
    "initProjectCode" : "String",
    "codeSrc" : "String",
    "htmlTemplateVersion" : "String",
    "projectCode" : "String",
    "releaseType" : "String",
    "pkgName" : "String",
    "jobType" : "String",
    "atomType" : "String",
    "classifyName" : "String",
    "userCommentInfo" : {
      "commentFlag" : true,
      "commentId" : "String"
    },
    "summary" : "String",
    "recommendFlag" : true,
    "editFlag" : true,
    "creator" : "String",
    "defaultFlag" : true,
    "docsLink" : "String",
    "os" : "string",
    "updateTime" : "String",
    "privateReason" : "String",
    "version" : "String",
    "logoUrl" : "String",
    "atomCode" : "String",
    "labelList" : [ {
      "createTime" : 0,
      "labelType" : "String",
      "updateTime" : 0,
      "id" : "String",
      "labelName" : "String",
      "labelCode" : "String"
    } ],
    "createTime" : "String",
    "visibilityLevel" : "String",
    "frontendType" : "ENUM",
    "name" : "String",
    "repositoryAuthorizer" : "String",
    "publisher" : "String",
    "classifyCode" : "String",
    "category" : "String",
    "dailyStatisticList" : [ {
      "dailySuccessNum" : 0,
      "statisticsTime" : "String",
      "dailyFailNum" : 0,
      "dailyFailRate" : "parse error",
      "dailyDownloads" : 0,
      "totalDownloads" : 0,
      "dailySuccessRate" : "parse error",
      "dailyFailDetail" : {
        "string" : "string"
      }
    } ]
  },
  "message" : "String",
  "status" : 0
}

数据返回包装模型AtomVersion

参数名称 参数类型 必须 参数说明
data AtomVersion 数据
message string 错误信息
status integer 状态码

AtomVersion

参数名称 参数类型 必须 参数说明
versionContent string 版本日志
flag boolean 是否可安装标识
modifier string 修改人
description string 插件描述
language string 开发语言
yamlFlag boolean yaml可用标识 true:是,false:否
atomId string 插件ID
atomStatus string 插件状态
initProjectCode string 插件的初始化项目
codeSrc string 代码库链接
htmlTemplateVersion string 前端渲染模板版本(1.0代表历史存量插件渲染模板版本)
projectCode string 插件的调试项目
releaseType string 发布类型
pkgName string 插件包名
jobType string 适用Job类型
atomType string 插件类型
classifyName string 插件分类名称
userCommentInfo 用户评论信息 用户评论信息
summary string 插件简介
recommendFlag boolean 是否推荐标识 true:推荐,false:不推荐
editFlag boolean 是否可编辑
creator string 创建人
defaultFlag boolean 是否为默认插件(默认插件默认所有项目可见)true:默认插件 false:普通插件
docsLink string 插件说明文档链接
os List 操作系统
updateTime string 修改时间
privateReason string 插件代码库不开源原因
version string 版本号
logoUrl string logo地址
atomCode string 插件标识
labelList List<标签信息> 标签列表
createTime string 创建时间
visibilityLevel string 项目可视范围,PRIVATE:私有 LOGIN_PUBLIC:登录用户开源
frontendType ENUM(HISTORY, NORMAL, SPECIAL, ) 前端UI渲染方式
name string 插件名称
repositoryAuthorizer string 插件代码库授权者
publisher string 发布者
classifyCode string 插件分类code
category string 插件范畴
dailyStatisticList List<每日统计信息> 每日统计信息列表

用户评论信息

参数名称 参数类型 必须 参数说明
commentFlag boolean 是否已评论 true:是,false:否
commentId string 评论ID

标签信息

参数名称 参数类型 必须 参数说明
createTime integer 创建日期
labelType string 类别 ATOM:插件 TEMPLATE:模板 IMAGE:镜像 IDE_ATOM:IDE插件
updateTime integer 更新日期
id string 标签ID
labelName string 标签名称
labelCode string 标签代码

每日统计信息

参数名称 参数类型 必须 参数说明
dailySuccessNum integer 每日执行成功数
statisticsTime string 统计时间,格式yyyy-MM-dd HH:mm:ss
dailyFailNum integer 每日执行失败数
dailyFailRate number 每日执行失败率
dailyDownloads integer 每日下载量
totalDownloads integer 总下载量
dailySuccessRate number 每日执行成功率
dailyFailDetail object 每日执行失败详情