# 根据组件ID获取记录 - ObtainRecordsBasedOnTheComponentID
#### 功能介绍
此API用于通过组件ID获取记录。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ServiceStage/doc?api=ShowComponentRecords&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                            | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                    | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | servicestage:app:listComponent | list | -           | -   | servicestage:app:list | -      |
     
  
 
#### URI
GET /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/records
表1路径参数 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| project_id     | 是    | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                    |
| application_id | 是    | String | **参数解释：** 应用ID。获取方法，请参考[获取所有应用 - ObtainAllApplications](https://support.huaweicloud.com/api-servicestage/servicestage_06_0068.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| component_id   | 是    | String | **参数解释：** 组件ID。获取方法，请参考[获取应用所有组件 - ObtainAllComponentsOfAnApplication](https://support.huaweicloud.com/api-servicestage/servicestage_06_0077.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                  |
   
表2查询参数 
| 参数       | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| limit    | 否    | Integer | **参数解释：** 查询个数。 **约束限制：** 不涉及 **取值范围：** 1\~100 **默认取值：** 10                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| offset   | 否    | Integer | **参数解释：** 查询偏移量，表示查询第n条数据后的结果。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| order_by | 否    | String  | **参数解释：** 排序字段。 **约束限制：** 不涉及 **取值范围：** - create_time：组件创建时间。  - name：组件名称。  - update_time：组件修改时间。   传值不在支持的枚举值范围内的话按create_time排序。 **默认取值：** create_time |
| order    | 否    | String  | **参数解释：** 排序方式。 **约束限制：** 不涉及 **取值范围：** - desc：降序排序。  - asc：升序排序。   **默认取值：** desc                                                                                                                                                                                                                                                                                                                                                                      |
   
#### 请求消息
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| Content-Type | 是    | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及                                                                                                                              |
| X-Auth-Token | 是    | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 响应消息
表4响应参数 
| 参数      | 参数类型             | 描述                                                                                                                                                                                                                                                        |
|:---|:---|:---|
| count   | Integer          | **参数解释：** 记录总数。 **取值范围：** 不涉及 |
| records | Array of objects | **参数解释：** 记录列表，请参考[表5]。                                                                                        |
   
 表5records参数 
| 参数           | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| begin_time   | String           | **参数解释：** 开始时间。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| end_time     | String           | **参数解释：** 结束时间。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| description  | Object           | **参数解释：** 描述。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| instance_id  | String           | **参数解释：** 实例ID。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| version      | String           | **参数解释：** 版本号。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| current_used | Boolean          | **参数解释：** 当前是否使用。 **取值范围：** - true：使用  - false：不使用                                                                                                                                                                                                                                                                                                                                         |
| status       | String           | **参数解释：** 状态。 **取值范围：** - RUNNING：运行中。  - FAILED：失败。  - SUCCEEDED：成功。                                                                                                                                                                                                                                   |
| deploy_type  | String           | **参数解释：** 部署类型。 **取值范围：** - OneBatchRelease：单批部署。  - RollingRelease：滚动部署。  - GrayRelease：灰度发布。   |
| jobs         | Array of objects | **参数解释：** 任务列表 ，请参考[表6]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   
 表6jobs 
| 参数          | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| sequence    | Integer | **参数解释：** 执行顺序。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| deploy_type | String  | **参数解释：** 部署类型。 **取值范围：** - OneBatchRelease：单批部署。  - RollingRelease：滚动部署。  - GrayRelease：灰度发布。   |
| job_id      | String  | **参数解释：** 任务ID。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| job_info    | Object  | **参数解释：** 任务信息，请参考[表7]。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
 表7job_info 
| 参数                  | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| deploy_type         | String  | **参数解释：** 部署类型。 **取值范围：** - OneBatchRelease：单批部署。  - RollingRelease：滚动部署。  - GrayRelease：灰度发布。   |
| source_url          | String  | **参数解释：** 组件来源。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                          |
| first_batch_weight  | Integer | **参数解释：** 首次执行权重。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                         |
| first_batch_replica | Integer | **参数解释：** 首次部署组件实例。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                     |
| replica             | Integer | **参数解释：** 总实例。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                          |
| remaining_batch     | Integer | **参数解释：** 剩余批次。 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                        |
   
#### 请求示例
无
#### 响应示例
```
{
  "count": 10,
  "records": [
    {
      "begin_time": "string",
      "end_time": "string",
      "description": null,
      "instance_id": "string",
      "version": "string",
      "current_used": true,
      "status": "string",
      "deploy_type": "string",
      "jobs": [
        {
          "sequence": 0,
          "deploy_type": "string",
          "job_id": "string",
          "job_info": {
            "deploy_type": "string",
            "source_url": "string",
            "first_batch_weight": 0,
            "first_batch_replica": 0,
            "replica": 0,
            "remaining_batch": 0
          }
        }
      ]
    }
  ]
}
```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 操作成功    |
| 400 | 错误的请求   |
| 404 | 请求对象不存在 |
| 500 | 内部错误    |
   
#### 错误码
请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。