更新时间:2024-02-06 GMT+08:00

获取应用所有组件

功能介绍

通过此API获取应用下所有应用组件。

URI

GET /v2/{project_id}/cas/applications/{application_id}/components

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID。获取方法,请参考获取项目ID

application_id

String

应用ID。获取方法,请参考获取所有应用

表2 查询参数

参数

是否必选

参数类型

描述

limit

String

指定个数,取值[0, 100]或者1000,指定的值不在该范围内的话相当于赋值为10。默认1000,用于不分页的场景。分页的场景取值请用[0, 100]。

offset

String

指定偏移量。

order_by

String

排序字段,默认按创建时间排序。

排序字段支持枚举值:create_time、name、update_time。

order

String

排序方式。

  • desc,降序排序,默认为desc。
  • asc,升序排序。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token

响应消息

表4 响应参数

参数

参数类型

描述

count

Integer

组件总数。

components

Array of objects

组件参数,请参考表5

表5 components参数

参数

参数类型

描述

id

String

应用组件ID。

name

String

应用组件名称。

status

integer

取值0或1。

0:表示正常状态。

1:表示正在删除。

runtime

String

运行时。

category

String

应用组件类型如:Webapp、MicroService、Common。

sub_category

String

应用组件子类型。

Webapp的子类型有Web。

MicroService的子类型有Java Chassis、Spring Cloud。

Common的子类型可以为空。

application_id

String

应用ID。

source

Object

代码/软件包来源,请参考表6

description

String

描述。

creator

String

创建人。

create_time

Integer

创建时间。

update_time

Integer

修改时间。

project_id

String

租户项目ID。

build

Object

构建工程,请参考表10

表6 source参数

参数

参数类型

描述

kind

String

类型,支持源码code和artifact软件包。

spec

Object

对应code请参考表7;对应artifact请参考表8

表7 code spec参数

参数

参数类型

描述

repo_type

String

代码仓类型,支持GitHub、BitBucket、GitLab。

repo_url

String

代码仓url,如:https://github.com/example/demo.git。

repo_ref

String

代码分支或者Tag,默认是master。

repo_auth

String

授权名称,在授权列表获取。

表8 artifact spec参数

参数

参数类型

描述

storage

String

存储方式。

type

String

类别。

url

String

软件包/源码地址。

auth

String

认证方式。

properties

Object

软件包的其他属性,只有在选择对象存储obs的时候才需要添加。请参考表9

表9 artifact spec properties参数

参数

参数类型

描述

endpoint

String

obs的终端地址,比如:https://obs.region_name.external_domain_name.com。

bucket

String

软件包在obs的桶名。

key

String

obs桶中的对象,一般是软件包名,有文件夹的话要加上文件夹的路径。比如test.jar或者demo/test.jar。

表10 build参数

参数

参数类型

描述

id

String

构建工程id。

parameters

Map<String,String>

请参考表11

表11 parameters参数

参数

参数类型

描述

build_cmd

String

编译命令。

dockerfile_path

String

dockerfile地址。

artifact_namespace

String

构建归档组织。

cluster_id

String

指定构建集群的id。

node_label_selector

Map<String, String>

key是标签的键,value是标签的值。

请求示例

响应示例

{
    "components": [
       {
	"id": "384eb8d4-c193-4d84-9558-6fda2366b536",
	"name": "mycomponent",
	"runtime": "Java8",
	"category": "MicroService",
	"sub_category": "Java Chassis",
	"description": "",
	"project_id": "384eb8d4-c193-4d84-9558-6fda23698536",
	"application_id": "a8f7eed5-0aa0-4251-9723-c9119a6bf56d",
        "source": {
		"kind": "artifact",
		"spec": {
			"storage": "obs",
			"type": "package",
			"url": "obs://myapp/demo.jar",
			"properties": {
				"bucket": "myapp",
				"key": "demo.jar",
				"endpoint": "https://obs.region_id.external_domain_name.com"
			}
		}
	},
	"build": {
		"id": "w3dpv7p0t1vpxvey5hjb22iuwxway1vupwx0nae1",
		"parameters": {
			"artifact_namespace": "ns",
			"use_public_cluster": true
		}
	},
	"status": 0,
	"creator": "xxx",
	"create_time": 1610333934288,
	"update_time": 1610333934288
       }
    ], 
    "count": 1
}

状态码

表12 状态码说明

HTTP状态码

描述

200

操作成功

400

错误的请求

404

请求对象不存在

500

内部错误

错误码

错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码