文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 历史API/ 应用管理（v2版本）/ 实例/ 获取组件实例
更新时间：2024-10-16 GMT+08:00
查看PDF
分享

获取组件实例

功能介绍

通过此API获取组件下的所有组件实例。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

application_id

是

String

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

component_id

是

String

组件ID。获取方法，请参考获取应用所有组件。
表2 查询参数

参数

是否必选

参数类型

描述

maxWaitTime

否

int

用户自定义整体启动时间。

limit

否

Integer

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

offset

否

Integer

指定偏移量。

order_by

否

String

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

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

order

否

String

排序方式。

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

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

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

响应消息

表4 响应参数

参数

参数类型

描述

count

Integer

实例总数。

instances

Array of objects

实例参数，请参考表5。
表5 instance

参数

参数类型

描述

id

String

应用组件实例ID。

application_id

String

应用ID。

application_name

String

应用名称。

component_id

String

组件ID。

component_name

String

组件名称。

name

String

应用组件实例名称。

environment_id

String

应用组件环境ID。

environment_name

String

环境名称。

platform_type

String

运行平台类型。

应用可以在不同的平台上运行，可选用的平台的类型有以下几种：cce、vmapp。

artifacts

Map<String, Object>

组件部署件。key为组件component_name，对于Docker多容器场景，key为容器名称,请参考表6。

creator

String

创建人。

version

String

应用组件版本号。

create_time

Integer

创建时间。

update_time

Integer

修改时间。

external_accesses

Array of objects

访问方式，请参考表7。

status_detail

Object

状态详情，请参考表8。
表6 artifact

参数

参数类型

描述

storage

String

存储方式，支持软件仓库swr、镜像仓库swr、对象存储obs、软件发布库codearts。

type

String

类别。

  • 虚拟机部署支持软件包package。
  • 容器部署支持软件包package、镜像包image。

url

String

软件包/镜像地址。

auth

String

认证方式，支持iam和none，默认为iam。

version

String

版本号。

properties

Map<String,String>

属性。
表7 external_accesses

参数

参数类型

描述

id

String

访问方式ID

protocol

String

协议

address

String

访问地址

forward_port

Integer

应用组件进程监听端口

type

String

类型

status

String

状态

create_time

Integer

创建时间

update_time

Integer

修改时间
表8 status_detail

参数

参数类型

描述

enterprise_project_id

String

企业项目ID

status

String

实例状态

available_replica

Integer

正常实例副本数

replica

Integer

实例副本数

fail_detail

String

失败描述

last_job_id

String

最近Job ID

last_job_status

String

最近Job的状态

请求示例

无

响应示例

{
	"instances": [
		{
			"id": "11eddb33-140b-4e51-b1e2-6ec265373ca3",
			"application_id": "4d92833a-fa05-4fc0-a761-e67620022310",
			"application_name": "test-app",
			"component_id": "1cfdda6f-84cd-4ead-8e09-628fabf662e2",
			"component_name": "test-com",
			"name": "test-micro-test-env-7iafjk",
			"environment_id": "61b81021-21d5-42f3-b80e-0b6bd10dbf7d",
			"environment_name": "test-env",
			"platform_type": "cce",
			"version": "1.0.0",
			"artifacts": {
				"test-micro": {
					"storage": "obs",
					"type": "package",
                                        "url": "obs://myapp/demo.jar",
	                                "properties": {
				            "bucket": "myapp",
				            "key": "demo.jar",
				            "endpoint": "https://obs.region_id.external_domain_name.com"
			                 },
					"auth": "iam",
					"version": "1.0.0",					
				}
			},
			"create_time": 1610331819996,
			"update_time": 1610331830398,
			"creator": "test_user",
			"status_detail": {
				"status": "RUNNING",
				"replica": 1,
				"available_replica": 1,
				"fail_detail": null,
				"last_job_id": "JOB7bc0366c-dc43-41f9-b65f-8d6078038488",
				"last_job_status": "SUCCEEDED",
				"enterprise_project_id": "0"
			}
		}
	],
	"count": 1
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

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

父主题： 实例