文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 组件/ 获取组件列表
更新时间：2024-11-14 GMT+08:00
查看PDF
分享

获取组件列表

功能介绍

获取组件列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/cae/applications/{application_id}/components

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

application_id

是

String

应用ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

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

offset

否

String

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

sort_key

否

String

排序字段。

sort

否

String

升降序规则。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Enterprise-Project-ID

否

String

企业项目ID。

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

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

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

说明：

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

api_version

String

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

kind

String

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

items

Array of ComponentItem objects

组件列表。

total_count

Integer

分页总数。
表5 ComponentItem

参数

参数类型

描述

id

String

组件ID。

name

String

组件名称。

annotations

map<string, object>

附加信息。

created_at

String

创建时间。

updated_at

String

更新时间。

spec

ComponentSpec object

组件规格。
表6 ComponentSpec

参数

参数类型

描述

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

组件状态。

build_log_id

String

构建日志ID。

configuration_operation_id

String

组件最新配置的操作ID。
表7 Source

参数

参数类型

描述

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地址为软件包地址。
表8 Repo

参数

参数类型

描述

auth_name

String

授权名称。

branch

String

分支。

namespace

String

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

参数

参数类型

描述

archive

Archive object

构建产物纳管。

parameters

map<string, object>

构建附加参数。

  • base_image：基础镜像地址。

  • build_cmd：自定义构建命令。

  • dockerfile_path：自定义dockerfile文件路径

  • dockerfile_content：自定义dockerfile内容

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

参数

参数类型

描述

artifact_namespace

String

产物纳管SWR组织。
表11 ResourceLimit

参数

参数类型

描述

cpu_limit

String

cpu限额。

memory_limit

String

内存限额。
表12 Access

参数

参数类型

描述

address

String

访问地址。

type

String

访问方式类型。

请求示例

获取组件列表。

GET https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components

响应示例

状态码： 200

请求成功。

{
  "api_version" : "v1",
  "kind" : "Component",
  "items" : [ {
    "id" : "610fb1de-5ac6-424e-b910-d7be902575d0",
    "name" : "demo-xxx",
    "annotations" : {
      "version" : "1.0.0",
      "enterprise_project_id" : ""
    },
    "created_at" : "2022-06-09T07:01:05.323979Z",
    "updated_at" : "2022-06-09T07:01:05.323979Z",
    "spec" : {
      "runtime" : "Docker",
      "env_id" : "50d18173-5df0-4db4-a2b6-8a428d42146b",
      "replica" : 1,
      "source" : {
        "type" : "image",
        "url" : "xxx/demo-jar:v2"
      },
      "build" : {
        "archive" : {
          "artifact_namespace" : "xxx"
        },
        "parameters" : {
          "base_image" : ""
        }
      },
      "resource_limit" : {
        "cpu_limit" : "500m",
        "memory_limit" : "1Gi"
      },
      "image_url" : "xxx/demo-jar:v2",
      "available_replica" : 1,
      "job_id" : "251b7d84-c353-416a-864f-5878a94c3d28",
      "status" : "running",
      "configuration_operation_id" : "xxx"
    }
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 组件

相关文档