获取应用所有组件部署信息

功能介绍

此API用来获取应用下所有应用组件部署信息。

URI

POST /v2/{project_id}/cas/applications/{application_id}/components/overviews

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户项目ID。获取方法，请参考获取项目ID。
application_id	是	String	应用ID。获取方法，请参考获取所有应用。

请求消息

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	消息体的类型（格式），默认取值为“application/json;charset=utf8”。
X-Auth-Token	是	String	调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

表3 请求Body参数
参数	是否必选	参数类型	描述
limit	否	Integer	指定个数，明确指定的时候用于分页，取值[0，100]。不指定的时候表示不分页，最多查询1000条记录。
offset	否	Integer	指定查询偏移量，默认偏移量为0。
order_by	否	String	排序字段，默认按创建时间排序。排序字段支持枚举值：create_time、name、update_time。
order	否	String	desc/asc，默认desc。

响应消息

表4 响应参数
参数	参数类型	描述
count	Integer	组件个数。
components	Array of objects	组件部署信息列表。请参考表 components。

表5 components
参数	参数类型	描述
id	String	组件ID。
application_id	String	应用ID。
name	String	应用组件名称。
project_id	String	项目ID。
runtime	String	运行时类型。
category	String	应用组件类型包括：Webapp、MicroService、Common。
sub_category	String	应用组件子类型。 Webapp的子类型有Web、Magento、Wordpress。 MicroService的子类型有Java Chassis、Go Chassis、Mesher、SpringCloud。 Common的子类型可以为空。
description	String	组件描述。
status	Integer	取值0或1。 0：表示正常状态。 1：表示正在删除。
source	Object	组件来源。请参考表 source。
build	Object	构建工程。请参考表 build。
creator	String	创建人。
create_time	Long	创建时间。
update_time	Long	修改时间。
instances	Array of objects	组件部署信息列表。请参考表 instances。

表6 source
参数	参数类型	描述
kind	String	来源类型。支持源码code和artifact软件包。
spec	Object	当组件来源的kind是artifact时spec的内容结构。请参考表 source spec。

表7 source spec
参数	参数类型	描述
storage	String	存储方式。支持软件仓库swr和对象存储obs。
type	String	类别。支持package。
url	String	软件包源码地址，如https://{IP}:20202/xxx/xxx.jar。
webUrl	String	软件包/源码仓库地址。
auth	String	认证方式，支持iam、none，默认是iam。
properties	Object	软件包的其他属性，只有在选择对象存储obs的时候才需要添加。请参考表 source spec properties。
repo_type	String	代码仓类型。支持GitHub、GitLab、Gitee、Bitbucket。
repo_url	String	代码仓url，如:https://github.com/example/demo.git。
repo_ref	String	代码分支或者Tag，默认是master。
repo_auth	String	授权名称，在授权列表获取。

表8 source spec properties
参数	参数类型	描述
endpoint	String	obs的终端地址，比如:https://obs.region_name.external_domain_name.com。
bucket	String	软件包在obs的桶名。
key	String	obs桶中的对象。一般是软件包名，有文件夹的话要加上文件夹的路径。比如test.jar或者demo/test.jar。

表9 build
参数	参数类型	描述
id	String	构建ID，查看构建列表获取。
parameters	Object	构建任务的环境变量。请参考表 build parameters。

**表10** build parameters
参数	参数类型	描述
build_cmd	String	编译命令。默认: 1、根目录存在build.sh：./build.sh 2、根据运行系统，示例如下: Java和Tomcat：mvn clean package Nodejs：npm build
dockerfile_path	String	dockerfile地址。默认是根目录./。
artifact_namespace	String	构建归档组织，默认cas_{project_id}。
cluster_id	String	指定构建集群的id。
node_label_selector	Object	key是标签的键，value是标签的值。

**表11** instances
参数	参数类型	描述
instance_id	String	应用组件实例ID。
instance_name	String	应用组件实例名称。
description	String	实例描述。
environment_id	String	应用组件环境ID。
platform_type	String	运行平台类型。应用可以在不同的平台上运行，可选用的平台的类型有以下几种:cce、vmapp。
flavor_id	String	资源规格。
artifacts	Map<String,Object>	组件部署件。key为组件component_name,对于Docker多容器场景,key为容器名称。value请参考表 instances artifacts。
version	String	应用组件版本号。
configuration	Object	应用组件配置,如环境变量。
creator	String	创建人。
create_time	Long	创建时间。
update_time	Long	修改时间。
external_accesses	Object	访问方式列表。请参考表 instances external_accesses。
refer_resources	Object	部署资源列表。请参考表 instances refer_resources。
status_detail	Object	状态详情。请参考表 instances status_detail。

**表12** instances artifacts
参数	参数类型	描述
storage	String	存储方式，支持swr、obs。
type	String	类别。虚机部署为package，容器部署为image。
url	String	软件包/镜像地址。对于需要使用组件的源码或者软件包自动生成的镜像，格式为“组件名:v${index}”
auth	String	认证方式。支持iam和none，默认为iam。
version	String	版本号。
properties	Object	属性。

**表13** instances external_accesses
参数	参数类型	描述
id	String	ID。
protocol	String	协议。
address	String	访问地址。
forward_port	Integer	应用组件进程监听端口。
type	String	类型。
status	String	状态。
create_time	Long	创建时间。
update_time	Long	修改时间。

**表14** instances refer_resources
参数	参数类型	描述
id	String	资源ID。
type	String	资源类型。基础资源：cce、ecs、as。可选资源：rds、dcs、elb、cse等其他类型。
refer_alias	String	应用别名，资源类型为dcs时才提供，支持“distributed_session”、“distributed_cache”、“distributed_session, distributed_cache”，默认值是“distributed_session, distributed_cache”。
parameters	Object	引用资源参数。

**表15** instances status_detail
参数	参数类型	描述
status	String	实例状态。
available_replica	Integer	正常实例副本数。
replica	Integer	实例副本数。
fail_detail	String	失败描述。 cluster_deleted表示集群被删除。 cluster_unavailable表示集群不可用。 cluster_inaccessible表示集群无法访问。 namespace_deleted表示命名空间被删除。 namespace_unavailable表示命名空间不可用。 namespace_inaccessible表示命名空间无法访问。 resource_deleted表示资源已删除。
last_job_id	String	最近Job ID。
last_job_status	String	最近Job的状态。
enterprise_project_id	String	企业项目ID。

请求示例

无

响应示例

{
        "components": [
                {
                        "description": "",
                        "id": "df490c83-875f-4c67-bee5-89a2b321cceb",
                        "application_id": "8cb9b39b-b8bd-4ef5-8263-e5ca83fbafb3",
                        "name": "sadxzc",
                        "runtime": "Docker",
                        "sub_category": "",
                        "source": {
                                "kind": "artifact",
                                "spec": {
                                        "auth": "iam",
                                        "storage": "swr",
                                        "type": "image",
                                        "url": "swr.test.com.cn/ss-test-ui-test:v1"
                                }
                        },
                        "status": 0,
                        "creator": "zhangyuhao",
                        "create_time": 1761649242446,
                        "update_time": 1761703557147,
                        "project_id": "e72f3b5a22d8458cad5ed8cf40b86acf",
                        "instances": [
                                {
                                        "environment_id": "7c1ce30a-dca2-44a1-b3d8-85523c3c474c",
                                        "instance_id": "166f7e7a-34b1-4d8d-8646-0b57f8432f3b",
                                        "instance_name": "sadxzc-yw-cce-env02-s38smo",
                                        "version": "2025.1029.10074",
                                        "create_time": 1761649242570,
                                        "update_time": 1761703599817,
                                        "platform_type": "cce",
                                        "flavor_id": "CUSTOM-10G:null-null:null-null",
                                        "configuration": {
                                                "configs": []
                                        },
                                        "artifacts": {
                                                "sadxzc": {
                                                        "storage": "swr",
                                                        "type": "image",
                                                        "url": "swr.test.com.cn/ss-test-ui-test:v1",
                                                        "auth": "iam"
                                                }
                                        },
                                        "status_detail": {
                                                "status": "RUNNING",
                                                "replica": 1,
                                                "available_replica": 1
                                                "fail_detail": null,
                                                "last_job_id": "JOB9c7e6c3d-9172-4c12-b207-4a6ae8cc57bc",
                                                "last_job_status": "SUCCEEDED",
                                                "enterprise_project_id": "0"
                                        },
                                        "external_accesses": [
                                                {
                                                        "protocol": "HTTP",
                                                        "address": "www.sad",
                                                        "forward_port": 22,
                                                        "type": "SPECIFIED",
                                                        "status": "NORMAL",
                                                        "create_time": 1761703557194,
                                                        "update_time": 1761703557194
                                                },
                                                {
                                                        "protocol": "tcp",
                                                        "address": "71.160.219.138",
                                                        "forward_port": 30464,
                                                        "type": "IP_ADDR",
                                                        "status": "NORMAL",
                                                        "create_time": 1761706159709,
                                                        "update_time": 1761706159709
                                                }
                                        ],
                                        "refer_resources": [
                                                {
                                                        "id": "cba3cafc-59b8-4330-b8ee-987bc03c78c6",
                                                        "type": "dcs",
                                                        "refer_alias": "distributed_session,distributed_cache",
                                                        "parameters": {
                                                                "name": "dcs-klq7",
                                                                "cluster": false
                                                        }
                                                }
                                        ]
                                }
                        ]
                }
        ],
        "count": 1
}

状态码

状态码	描述
200	操作成功。
400	错误的请求。
404	请求对象不存在。
500	内部错误。

错误码

请参考ServiceStage错误码。

父主题： 组件

上一篇：根据组件ID获取组件信息

下一篇：实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消