文档首页> 云应用引擎 CAE> API参考> CAE API> 组件> 获取组件实例列表
更新时间：2023-12-27 GMT+08:00
查看PDF
分享

获取组件实例列表

功能介绍

获取组件实例列表。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

application_id

是

String

应用ID。

component_id

是

String

组件ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

最大长度：16384

X-Enterprise-Project-ID

否

String

企业项目ID。

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

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

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

说明：

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

X-Environment-ID

是

String

环境ID。

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

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

api_version

String

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

枚举值：

  • v1

kind

String

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

枚举值：

  • ComponentConfiguration

items

Array of Instance objects

组件实例列表。
表4 Instance

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

status

String

实例状态。

枚举值：

  • creating

  • running

  • abnormal

  • failed

  • terminating

请求示例

获取组件实例列表。

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

响应示例

状态码： 200

请求成功。

{
  "api_version" : "v1",
  "kind" : "ComponentInstance",
  "items" : [ {
    "id" : "d59a645b-730d-4a1a-951f-822a71dcdb9d",
    "name" : "test-image-5787bf845c-wzz99",
    "status" : "creating"
  } ]
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 组件
分享：

    相关文档

    相关产品