# 获取组件快照列表 - ListComponentSnapshots #### 功能介绍 获取组件快照列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CAE/doc?api=ListComponentSnapshots)中调试该接口，支持自动认证鉴权。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}/snapshots 表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类型，固定值"ComponentSnapshot"，该值不可修改。 | | items | Array of [ComponentSnapshotItem] objects | 快照列表。 | 表4ComponentSnapshotItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | component_id | String | 组件ID。 | | index | Integer | 快照索引。 | | context | [ComponentSnapshotContext] object | 上下文信息。 | | created_at | String | 创建时间。 | | updated_at | String | 更新时间。 | 表5ComponentSnapshotContext | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_id | String | 应用ID。 | | available_replica | Integer | 可用实例个数。 | | build | String | 组件构建信息。 | | build_id | String | 构建任务ID。 | | build_log_id | String | 构建日志ID。 | | env_id | String | 环境ID。 | | id | String | 组件ID。 | | image_url | String | 镜像地址。 | | job_id | String | 任务ID。 | | log_group_id | String | LTS日志组的ID。 | | log_stream_id | String | LTS日志流的ID | | name | String | 组件名称。 | | operation | String | 组件操作。 | | operation_status | String | 组件操作状态。 - failed: 失败。 - deploying: 部署中。 - retrying: 重试中。 - restarting: 重启中。 - scaling: 伸缩中。 - stopping: 停止中。 - starting: 启动中。 - rollingBack: 回滚中。 - upgrading: 升级中。 - configuring: 配置中。 - deleting: 删除中。 - deploy_failed: 部署失败。 - retry_failed: 重试失败。 - restart_failed: 重启失败。 - scale_failed: 伸缩失败。 - stop_failed: 停止失败。 - start_failed: 启动失败。 - rollback_failed: 回滚失败。 - upgrade_failed: 升级失败。 - configure_failed: 配置失败。 - delete_failed: 删除失败。 - create_succeeded: 创建成功。 - deploy_succeeded: 部署成功。 - retry_succeeded: 重试成功。 - restart_succeeded: 重启成功。 - scale_succeeded: 伸缩成功。 - stop_succeeded: 停止成功。 - start_succeeded: 启动成功。 - rollback_succeeded: 回滚成功。 - upgrade_succeeded: 升级成功。 - configure_succeeded: 配置成功。 | | replica | Integer | 实例个数。 | | resource_limit | String | 组件规格。 | | runtime | String | 语言/运行时。 | | source | String | 组件源信息。 | | status | String | 组件状态。 - created: 未部署。 - running: 运行中。 - paused: 已停止。 - notReady: 未就绪。 | | version | String | 组件版本。 | | created_at | String | 创建时间。 | | updated_at | String | 更新时间。 | #### 请求示例 获取组件快照列表。 ``` GET https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/snapshots ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "api_version" : "v1", "kind" : "ComponentSnapshot", "items" : [ { "component_id" : "79229698-e2ec-47db-81df-599b59a9fc17", "index" : 1, "context" : { "app_id" : "d65fd1d7-9df8-424f-ba4d-44b1bb7cfc05", "available_replica" : 1, "build" : "{\"archive\":{\"artifact_namespace\":\"cae-test\"},\"parameters\":{\"base_image\":\"\"}}", "env_id" : "7eb2f920-e183-4d4e-9b9d-fffb875ae520", "id" : "79229698-e2ec-47db-81df-599b59a9fc17", "image_url" : "nginx:stable-alpine-perl", "job_id" : "4681ac3f-5771-4d98-97ad-9e25171b26b8", "log_group_id" : "96fe4c34-578a-4ea8-8e77-ee59bf8a0fd1", "log_stream_id" : "9c024ad2-5c80-45ee-8651-5f2bd89d3c7e", "name" : "test", "operation" : "deploy", "operation_status" : "started", "replica" : 1, "resource_limit" : "{\"cpu_limit\":\"500m\",\"memory_limit\":\"1Gi\"}", "runtime" : "Docker", "source" : "{\"type\":\"image\",\"url\":\"nginx:stable-alpine-perl\"}", "status" : "running", "version" : "1.0.0", "created_at" : "2023-02-27T06:22:46.812877Z", "updated_at" : "2023-02-27T06:22:46.812877Z" }, "created_at" : "2023-02-27T08:26:39.362226Z", "updated_at" : "2023-02-27T08:26:39.362226Z" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cae/ErrorCode.html)。