获取组件列表

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

application_id

是

String

应用ID。

limit

否

String

限制本次返回结果的条数。

offset

否

String

分页偏移位，查询起始位置。

status

否

String

参数解释：

组件状态。

取值范围：

• created: 未部署。

• running: 运行中。

• paused: 已停止。

• notReady: 未就绪。

默认取值：

此字段为非必选项，不传递时，接口可正常调用且返回全部状态的组件。

sort_key

否

String

参数解释：

排序字段。

取值范围：

• created_at: 组件创建时间。

• updated_at: 组件更新时间。

默认取值：

此字段为非必选项，不传递时，接口可正常调用且默认为created_at。

sort

否

String

参数解释：

升降序规则。

取值范围：

• asc: 升序。

• desc: 降序。

默认取值：

此字段为非必选项，不传递时，接口可正常调用且默认为desc。

X-Auth-Token

是

String

用户Token。

• 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

  • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

• 创建环境时，环境会绑定企业项目ID。

• 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

• 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

X-Environment-ID

是

String

环境ID。

• 获取环境ID，通过获取环境列表来获取环境信息。

• 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

api_version

String

API版本，固定值“v1”，该值不可修改。

kind

String

API类型，固定值“Component”，该值不可修改。

items

Array of ComponentItem objects

组件列表。

total_count

Integer

分页总数。

id

String

组件ID。

name

String

组件名称。

annotations

Annotations object

附加信息。

created_at

String

创建时间。

updated_at

String

更新时间。

spec

ComponentSpec object

组件规格。

{自定义key}

Map<String,String>

资源信息。

runtime

String

语言/运行时。

env_id

String

环境ID。

replica

Integer

实例个数。

source

Source object

源信息。

build

Build object

构建信息。

resource_limit

ResourceLimit object

实例规格。

access_info

Array of Access objects

访问方式列表。

image_url

String

镜像地址。

available_replica

Integer

可用实例个数。

job_id

String

任务ID。

build_id

String

构建任务ID。

status

String

组件状态。

• created: 未部署。

• running: 运行中。

• paused: 已停止。

• notReady: 未就绪。

job_status

String

组件上次的操作结果。

• deploying：部署中。

• retrying：重试中。

• restarting：重启中。

• scaling：伸缩中。

• stopping：停止中。

• starting：启动中。

• rollingBack：回滚中。

• upgrading：升级中。

• configuring：配置中。

• deleting：删除中。

• deploy_failed：部署失败。

• retry_failed：重试失败。

• restart_failed：重启失败。

• scale_failed：伸缩失败。

• stop_failed：停止失败。

• start_failed：启动失败。

• rollback_failed：回滚失败。

• upgrade_failed：升级失败。

• configure_failed：配置失败。

• delete_failed：删除失败。

• create_succeeded：创建成功。

• deploy_succeeded：部署成功。

• retry_succeeded：重试成功。

• restart_succeeded：重启成功。

• scale_succeeded：伸缩成功。

• stop_succeeded：停止成功。

• start_succeeded：启动成功。

• rollback_succeeded：回滚成功。

• upgrade_succeeded：升级成功。

• configure_succeeded：配置成功。

build_log_id

String

构建日志ID。

configuration_operation_id

String

组件最新配置的操作ID。

terminated

String

组件上执行的任务是否被强制终止。

code

Repo object

源码仓库信息。

type

String

源类型。

sub_type

String

源子类型。

• 源类型为code时，子类型表示不同的代码仓库，如DevCloud（CodeArts）、GitLab、GitHub、Gitee、Bitbucket。

• 源类型为softwarePackage时，子类型表示不同的软件包仓库，如BinObs、BinDevCloud（CodeArts软件发布库）。

url

String

url地址。

• 源类型为image时，url地址为镜像地址。

• 源类型为code时，url地址为git地址。

• 源类型为softwarePackage时，url地址为软件包地址。

auth_name

String

授权名称。

branch

String

分支。

namespace

String

命名空间，需填写命名空间的Base64编码。

archive

Archive object

构建产物纳管。

parameters

Parameters object

artifact_namespace

String

产物纳管SWR组织。

{自定义key}

Map<String,String>

构建附加参数。

• base_image：基础镜像地址。

• build_cmd：自定义构建命令。

• dockerfile_path：自定义dockerfile文件路径

• dockerfile_content：自定义dockerfile内容

• artifact_name: 针对java多模块构建，指定构建后运行的产物，以".jar"结尾。

cpu_limit

String

cpu限额。

memory_limit

String

内存限额。

address

String

访问地址。

type

String

访问方式类型。

200

请求成功。