文档首页/ 安全云脑 SecMaster/ API参考/ API V2/ 组件管理/ 展示组件详情
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

展示组件详情

功能介绍

展示组件详情

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID

约束限制：

不涉及

取值范围：

不涉及w

默认取值：

不涉及

workspace_id

是

String

工作空间ID

component_id

是

String

组件ID
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Long

Limit

offset

否

Integer

参数解释：

偏移量

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sort_key

否

String

按照属性排序。

sort_dir

否

String

排序顺序，支持 ASC 或 DESC。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

component_id

String

component id.

component_name

String

组件名称

version

String

安全云脑版本

history_version

String

历史版本

create_time

Integer

毫秒时间戳

update_time

Integer

毫秒时间戳

time_zone

String

时区

upgrade

String

参数解释:

升级

  • NEED_UPGRADE 需要升级

  • UPGRADING 升级中

  • SUCCESS_UPGRADE 升级成功

  • FAIL_UPGRADE 升级失败

约束限制

不涉及

取值范围:

  • NEED_UPGRADE

  • UPGRADING

  • SUCCESS_UPGRADE

  • FAIL_UPGRADE

默认值

不涉及

upgrade_fail_message

String

更新失败的消息

maintainer

String

保持

description

String

相关描述

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

无

状态码

状态码

描述

200

Response of show component

400

Error response

错误码

请参见错误码。

父主题： 组件管理

相关文档