按照名称分页查询应用 - ListApps

功能介绍

按照名称分页查询应用。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/app-center/apps

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	查询的偏移量，默认值0。
limit	否	Integer	单次查询的大小[1-100]，默认值10。
name	否	String	应用名称。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
count	Integer	总数。
items	Array of Application objects	应用列表。

表4 Application
参数	参数类型	描述
id	String	唯一标识。
tenant_id	String	租户id。
name	String	应用名称。
version	String	版本号。
description	String	描述。
authorization_type	String	ALL_USER - 全部用户 ASSIGN_USER - 授权指定用户
app_file_store	FileStoreLink object	应用存储信息。
app_icon_url	String	应用图标路径。
install_type	String	安装方式： QUIET_INSTALL - 静默安装。 UNZIP_INSTALL - 解压安装。 GUI_INSTALL - 用户通过GUI界面安装。安装命令(静默安装命令)，例: ${FILE_PATH} /S。例: unzip ${FILE_PATH}。 install_type为QUIET_INSTALL、UNZIP_INSTALL时install_command非空。预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。
install_command	String	安装命令(静默安装命令)。例: ${FILE_PATH} /S。预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。
uninstall_command	String	卸载命令(静默卸载命令)。例: msiexec /uninstall ${FILE_PATH} /quiet。预定义变量将采用以下值: ${FILE_PATH}: 应用安装包在桌面本地的存储路径。
support_os	String	系统类型： Linux - Windows - Other -
status	String	应用状态(正常、禁用) 'NORMAL' - 正常 'FORBIDDEN' - 禁用状态
application_source	String	应用来源： CUSTOM - 用户上传 SYSTEM - 内置应用 MARKET - 市场应用
create_time	String	应用创建时间。
catalog_id	String	分类ID。
catalog	String	分类名称。
install_info	String	安装信息。

表5 FileStoreLink
参数	参数类型	描述
store_type	String	存储方式： OBS - OBS桶存储。 LINK - 外部存储,使用的可访问下载链接。
bucket_store	BucketStore object	OBS桶存储。
file_link	String	文件下载完整路径。

表6 BucketStore
参数	参数类型	描述
bucket_name	String	桶名称固定格式:wks-appcenter-{project_id}; 需先调用桶授权接口进行授权。
bucket_file_path	String	OBS对象路径。注: bucket_file_path是对象在obs中的完整路径,不能以/开头。例如桶存在如下目录结构的数据。 Bucket: ├─dir1 \| ├─object1.txt \| └─object2.txt └─object3.txt Object1的路径: dir1/object1.txt Object2的路径: dir1/object2.txt Object3的路径: object3.txt

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

无

响应示例

状态码：200

成功响应。

{
  "count" : 0,
  "items" : [ {
    "id" : "x-xx-xxx",
    "tenant_id" : "xxx-xx-x-xx",
    "name" : "xxx.exe",
    "version" : "v1.1.1",
    "description" : "测试应用。",
    "authorization_type" : "ALL_USER",
    "app_file_store" : {
      "store_type" : "OBS",
      "bucket_store" : {
        "bucket_name" : "wks-appcenter-xxxx",
        "bucket_file_path" : "app-file/xxxx.exe"
      },
      "file_link" : "https://host-addresss/xxxxx.jpg"
    },
    "app_icon_url" : "https://host-addresss/xxxxx",
    "install_type" : "QUIET_INSTALL",
    "install_command" : "${FILE_PATH} /S",
    "uninstall_command" : "msiexec /uninstall ${FILE_PATH} /quiet",
    "support_os" : "Windows",
    "status" : "NORMAL",
    "application_source" : "CUSTOM",
    "create_time" : "2024-12-25T06:56:33.477Z",
    "catalog_id" : 1,
    "catalog" : "其他",
    "install_info" : "安装信息"
  } ]
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。