获取应用所有组件
功能介绍
此API用于获取应用下所有应用组件。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/cas/applications/{application_id}/components
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID。获取方法,请参考获取项目ID。 |
application_id |
是 |
String |
应用ID。获取方法,请参考获取所有应用。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
integer |
查询个数,取值[0, 100]。 |
offset |
否 |
integer |
查询偏移量,表示查询第n条数据后的结果。 |
order_by |
否 |
String |
排序字段。 排序字段支持以下枚举值:
传值不在支持的枚举值范围内的话按默认排序字段排序。 |
order |
否 |
String |
排序方式。
|
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
组件总数。 |
components |
Array of objects |
组件参数,请参考表5。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
组件ID。 |
name |
String |
组件名称。 |
labels |
Array of objects |
标签。容器部署方式部署的组件可通过标签查询对应工作负载;虚机部署方式部署的组件可配置对应的微服务名称的标签来使用优雅上下线功能,请参考表10。 |
status |
Object |
组件状态,请参考表8。 |
runtime_stack |
Object |
技术栈,请参考表7。 |
application_name |
String |
应用名称。 |
application_id |
String |
应用ID。 |
environment_name |
String |
环境名称。 |
environment_id |
String |
环境ID。 |
version |
String |
组件版本号。 |
source |
Object |
代码/软件包来源,请参考表6。 |
creator |
String |
组件创建人。 |
platform_type |
String |
组件部署类型。 |
external_accesses |
Array of objects |
外部访问,请参考表11。 |
参数 |
参数类型 |
描述 |
---|---|---|
kind |
String |
组件来源类型。
|
version |
String |
版本号。 |
url |
String |
包地址,类型为package和image时需要添加。 |
storage |
String |
存储方式,支持镜像仓库swr、软件仓库swr、软件开发生产线codearts和对象存储obs,类型为package和image时需要添加。 |
auth |
String |
认证方式,支持iam、none,默认是iam。 |
repo_auth |
String |
授权名称,在授权列表获取。 |
repo_namespace |
String |
代码仓库命名空间。 |
repo_ref |
String |
代码分支或者Tag,默认是master。 |
repo_type |
String |
代码仓类型,支持CodeArts、Gitee、GitHub、BitBucket、GitLab。 |
web_url |
String |
代码跳转链接,例如:https://github.com/example/demo.git。 |
repo_url |
String |
代码仓url,例如:https://github.com/example/demo.git。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
技术栈名称,例如:OpenJDK8。 |
type |
String |
技术栈类型,支持Java、Tomcat、Nodejs、Php、Docker、Python。 当部署模式为虚机部署时,仅支持Java、Tomcat、Nodejs;容器部署上述类型都支持。 |
version |
String |
技术栈版本,例如:1.1.4。 |
deploy_mode |
String |
部署模式。
|
参数 |
参数类型 |
描述 |
---|---|---|
component_status |
String |
组件状态。
|
available_replica |
Integer |
可用实例。 |
replica |
Integer |
总实例。 |
fail_detail |
String |
失败原因。
|
last_job_id |
String |
最后执行任务ID。 |
create_time |
Integer |
创建时间。 |
update_time |
Integer |
更新时间。 |
creator |
String |
创建人。 |
artifact |
Object |
组件构建信息,请参考表9。 |
请求示例
无
响应示例
{ "components": [ { "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "storage": "obs" }, "name": "mycomponent", "id": "b8702b0f-94d3-4822-98a1-56815632a0a0", "labels": null, "runtime_stack": { "name": "OpenJDK8", "deploy_mode": "virtualmachine", "version": "1.1.1" }, "external_accesses": null, "status": { "component_status": "RUNNING", "available_replica": 1, "replica": 1, "fail_detail": null, "last_job_id": "JOB8be53b2a-af9a-4e2b-8505-096688a52237", "creator": "ss-test", "create_time": 1679556221028, "update_time": 1679556318779 }, "environment_name": "sudo", "environment_id": "4d084044-0b80-4641-963c-b9c9f4092a4f", "application_name": "app-39mbbn", "application_id": "fc092465-a5fb-4a52-bc65-b735f18366d8", "creator": "ss-test", "platform_type": "cce", "version": "2023.0323.15181" } ], "count": 1 }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功 |
400 |
错误的请求 |
404 |
请求对象不存在 |
500 |
内部错误 |
错误码
错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码。