文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 组件/ 根据组件ID获取记录
更新时间：2024-12-16 GMT+08:00
查看PDF
分享

根据组件ID获取记录

功能介绍

此API用于通过组件ID获取记录。

URI

GET /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/records

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

application_id

是

String

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

component_id

是

String

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

参数

是否必选

参数类型

描述

limit

否

String

指定个数，取值[0, 100]。

offset

否

String

指定偏移量。

order_by

否

String

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

排序字段支持枚举值：create_time、name、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

记录总数。

records

Array of objects

记录列表，请参考表5。
表5 records参数

参数

参数类型

描述

begin_time

String

开始时间。

end_time

String

结束时间。

description

Object

描述。

instance_id

String

实例ID。

version

String

版本号。

current_used

Boolean

当前使用。

status

String

状态。

deploy_type

String

部署类型。

  • OneBatchRelease，单批部署。
  • RollingRelease，滚动部署。
  • GrayRelease，灰度发布。

jobs

Array of objects

任务列表 ，请参考表6。
表6 jobs

参数

参数类型

描述

sequence

Integer

执行顺序。

deploy_type

String

部署类型。

  • OneBatchRelease，单批部署。
  • RollingRelease，滚动部署。
  • GrayRelease，灰度发布。

job_id

String

任务ID。

job_info

Object

任务信息，请参考表7。
表7 job_info

参数

参数类型

描述

deploy_type

String

部署类型

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

内部错误

错误码

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

父主题： 组件