
# 获取组件实例列表 - ListComponentInstances
#### 功能介绍
获取组件实例列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CAE/doc?api=ListComponentInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cae/cae_06_0016.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
#### URI
GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances
表1路径参数 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                |
|:---|:---|:---|:---|
| project_id     | 是    | String | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-cae/cae_06_0021.html)。 |
| application_id | 是    | String | 应用ID。                                                                             |
| component_id   | 是    | String | 组件ID。                                                                             |
#### 请求参数
表2请求Header参数 
| 参数                      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| X-Auth-Token            | 是    | String | 用户Token。 - 获取Token，请参考《[统一身份认证服务API参考](https://support.huaweicloud.com/api-iam/iam_30_0001.html)》的"获取用户Token"章节。 - 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。                                                               |
| X-Enterprise-Project-ID | 否    | String | 企业项目ID。 - 创建环境时，环境会绑定企业项目ID。 - 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。 - 该字段不传（或传为字符串"0"）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《[企业管理服务用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)》。 |
| X-Environment-ID        | 是    | String | 环境ID。 - 获取环境ID，通过[获取环境列表](https://support.huaweicloud.com/api-cae/ListEnvironments.html)来获取环境信息。 - 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。                                                                            |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                                                    | 描述                                        |
|:---|:---|:---|
| api_version | String                                                                  | API版本，固定值"v1"，该值不可修改。                     |
| kind        | String                                                                  | API类型，固定值"ComponentConfiguration"，该值不可修改。 |
| items       | Array of [Instance] objects | 组件实例列表。                                   |
   
 表4Instance 
| 参数     | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|
| id     | String | 实例ID。                                                                                                                                                                                                                                                                                                                                                                     |
| name   | String | 实例名称。                                                                                                                                                                                                                                                                                                                                                                     |
| status | String | **参数解释：** 实例状态。 **约束限制：** 不涉及。 **取值范围：** - creating：实例处于创建阶段。此时正在执行容器镜像拉取、容器初始化等前置操作，尚未进入可运行状态。 - running：实例运行正常。已成功启动且至少有一个容器处于活跃运行状态，整体功能符合预期。 - abnormal：实例运行异常。可能因健康检查未通过、资源使用超限（如CPU/内存不足）等原因导致状态不符合预期，需结合具体事件日志进一步排查原因。 - 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 | 请求成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-cae/ErrorCode.html)。
