文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 应用/ 获取所有应用
更新时间：2024-10-11 GMT+08:00
查看PDF
分享

获取所有应用

功能介绍

通过此API可以获取所有已经创建的应用。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/cas/applications

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法，请参考获取项目ID。
表2 查询参数

参数

是否必选

参数类型

描述

limit

否

integer

查询个数，取值[0, 100]。

offset

否

intege

查询偏移量，表示查询第n条数据后的结果。

order_by

否

String

排序字段。

排序字段支持以下枚举值：

  • create_time，应用创建时间，默认排序字段。
  • name，应用名称。
  • update_time，应用修改时间。

传值不在支持的枚举值范围内的话按默认排序字段排序。

order

否

String

排序方式。

  • 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

应用总数。

applications

Array of object

应用信息，请参考表5。
表5 applications

参数

参数类型

描述

id

String

应用ID。

name

String

应用名称。

description

String

应用描述。

creator

String

应用创建人。

project_id

String

项目ID。

enterprise_project_id

String

企业项目ID。

create_time

Integer

应用创建时间。

update_time

Integer

应用修改时间。

component_count

Integer

应用下部署的组件个数。

labels

Array of objects

标签，可使用标签管理服务通过标签过滤资源，请参考表6。
表6 labels

参数

参数类型

描述

key

String

标签名称。

value

String

标签值。

请求示例

无

响应示例

{
    "count": 1,
    "applications": [
        {
            "id": "dae29983-c1e9-437d-a6be-5256076fe605",
            "name": "app-xpmtii",
            "description": "test",
            "project_id": "063a3158b1a34710b36ad208b9497d00",
            "enterprise_project_id": "0",
            "creator": "ss-test",
            "create_time": 1679468852302,
            "update_time": 1679468852302,
            "labels": [
                {
                    "key": "key",
                    "value": "var"
                }
            ],
            "component_count": 0
        }
    ]
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

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

父主题： 应用

相关文档