更新时间:2023-07-11 GMT+08:00

获取组件实例快照

功能介绍

通过此API获取应用组件实例的快照信息。

实例快照是指升级后,之前版本的实例信息,可以用于回滚。

URI

GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id}/snapshots

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

application_id

String

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

component_id

String

组件ID。获取方法,请参考获取应用所有组件

instance_id

String

组件实例ID。获取方法,请参考获取组件实例

表2 查询参数

参数

是否必选

参数类型

描述

limit

Integer

指定个数,取值[0, 100]或者1000,指定的值不在该范围内的话相当于赋值为10。默认1000,用于不分页的场景。分页的场景取值请用[0, 100]。

offset

Integer

指定偏移量。

order_by

String

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

order

String

排序方式。

  • desc,降序排序,默认为desc。
  • asc,升序排序。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token

响应消息

表4 响应参数说明

参数

参数类型

描述

count

Integer

快照总数。

snapshots

Array of Objects

快照参数,请参考表5

表5 snapshot参数说明

参数

参数类型

描述

create_time

Integer

创建时间

description

String

描述

instance_id

String

应用组件实例ID

version

String

版本号

请求示例

响应示例

{
	"snapshots": [
		{
			"version": "1.0.0",
			"description": "{\"action\":\"New Version: 1.0.0\"}",
			"instance_id": "11eddb33-140b-4e51-b1e2-6ec265373ca3",
			"create_time": 1610331830841
		}
	],
	"count": 1
}

状态码

表6 状态码说明

HTTP状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

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