列出组件配置 - ListComponentConfiguration
功能介绍
列出组件配置
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
component_id |
是 |
String |
组件ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Long |
Limit |
|
offset |
否 |
Integer |
参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
sort_key |
否 |
String |
按照属性排序。 |
|
sort_dir |
否 |
String |
排序顺序,支持 ASC 或 DESC。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
组件配置数量 |
|
records |
Array of ComponentConfiguration objects |
组件配置列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
component_id |
String |
component id. |
|
component_name |
String |
组件名称 |
|
node_id |
String |
节点ID |
|
create_time |
Integer |
毫秒时间戳 |
|
node_name |
String |
节点名称 |
|
specification |
String |
规范 |
|
config_status |
String |
参数解释: 节点配置状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
fail_deploy_message |
String |
部署失败的消息 |
|
ip_address |
String |
IP地址 |
|
private_ip_address |
String |
IP地址 |
|
region |
String |
地区 |
|
vpc_endpoint_id |
String |
VPC端点ID |
|
vpc_endpoint_address |
String |
VPC端点地址 |
|
monitor |
Monitor object |
监视器 |
|
node_expansion |
IsapNodeExpansion object |
节点扩展信息 |
|
node_apply_fail_enum |
String |
参数解释: 节点应用成功与否状态、原因
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
list |
Array of ComponentConfigurationParam objects |
组件配置参数列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
mini_on_online |
String |
是否在线 |
|
memory_count |
String |
物理内存条数量 |
|
memory_usage |
String |
已使用的物理内存量 |
|
memory_free |
String |
当前空闲的物理内存量 |
|
memory_shared |
String |
多个进程共享使用的内存总量 |
|
memory_cache |
String |
缓存数据的内存大小 |
|
cpu_usage |
String |
CPU 当前的使用率 |
|
cpu_idle |
String |
CPU 空闲时间的百分比 |
|
up_pps |
String |
上传数据包每秒数量 |
|
down_pps |
String |
下载数据包每秒数量 |
|
write_rate |
String |
磁盘写入速率 |
|
read_rate |
String |
磁盘读取速率 |
|
disk_count |
String |
系统中磁盘设备的数量 |
|
disk_usage |
String |
当前磁盘空间使用量 |
|
heart_beat_time |
Long |
最后一次接收到心跳信号的时间 |
|
health_status |
String |
参数解释: 节点的健康状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
heart_beat |
String |
参数解释: 节点是否成功收到心跳信号
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
node_id |
String |
UUID |
|
data_center |
String |
数据中心 |
|
custom_label |
String |
自定义标签 |
|
network_plane |
String |
网络平面 |
|
description |
String |
描述信息 |
|
maintainer |
String |
维护人 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configuration_id |
String |
配置ID |
|
component_id |
String |
component id. |
|
node_id |
String |
节点ID |
|
file_name |
String |
文件名称 |
|
file_path |
String |
文件路径 |
|
file_type |
String |
参数解释: 文件类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
param |
String |
参数 |
|
version |
Integer |
版本 |
|
type |
String |
参数解释: 配置类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Response of list component configuration |
|
400 |
Error response |
错误码
请参见错误码。