文档首页/ 路网数字化服务 DRIS/ API参考/ API/ 应用侧API参考/ Edge应用版本管理/ 查询应用版本列表
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

查询应用版本列表

功能介绍

查询应用版本列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。

取值范围：仅支持数字，a到f的小写字母组合，长度32。

edge_app_id

是

String

参数说明：用户自定义应用唯一ID。

取值范围：长度不大于32，只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。
表2 Query参数

参数

是否必选

参数类型

描述

version

否

String

参数说明：应用版本搜索关键字。

offset

否

Integer

参数说明：分页查询时的页码。

limit

否

Integer

参数说明：每页记录数。

state

否

String

参数说明：应用版本状态。

取值范围：

  • DRAFT：草稿

  • PUBLISHED：发布

  • OFF_SHELF：下线

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

参数说明：实例ID。DRIS物理实例的唯一标识，获取方法请参见“API参考 > 附录 > 获取Instance-Id”。

取值范围：仅支持数字，小写字母和连接符（-）的组合，长度36。

X-Auth-Token

否

String

参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 “获取IAM用户Token”接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见“API参考 > API > 应用侧API参考 > 如何调用API > 认证鉴权 > Token认证”。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Long

参数说明：总记录数。

versions

Array of QueryEdgeAppVersionBriefResponseDTO objects

参数说明：列举每条记录。
表5 QueryEdgeAppVersionBriefResponseDTO

参数

参数类型

描述

edge_app_id

String

参数说明：用户自定义应用唯一ID。

version

String

参数说明：应用版本。

description

String

参数说明：应用描述。

取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。

created_time

String

参数说明：创建时间。

last_modified_time

String

参数说明：最后一次修改时间。

state

String

参数说明：应用版本状态。

取值范围：

  • DRAFT：草稿

  • PUBLISHED：发布

  • OFF_SHELF：下线

publish_time

String

参数说明：发布时间。

off_shelf_time

String

参数说明：下线时间。

请求示例

GET https://{endpoint}/v1/{project_id}/v2x-edge-apps/{edge_app_id}/versions?version=2.0.1&state=DRAFT&offset=0&limit=10
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********

响应示例

状态码： 200

OK

{
  "count" : 1,
  "versions" : [ {
    "edge_app_id" : "17442350272644024878411165216381",
    "version" : "2.0.1",
    "description" : "hello",
    "created_time" : "2021-12-23T12:42:50",
    "last_modified_time" : "2021-12-23T12:42:50",
    "state" : "DRAFT",
    "publish_time" : null,
    "off_shelf_time" : null
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码。

父主题： Edge应用版本管理

相关文档