获取用户所属空间的应用列表
功能介绍
获取用户所属空间的应用列表。
URI
GET /v1/{project_id}/eihealth-projects/apps
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
is_creator |
否 |
Boolean |
参数解释: 是否仅展示本人创建资源。 约束限制: 不涉及 取值范围:
默认取值: true |
id |
否 |
String |
参数解释: 应用ID,支持精确搜索。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
name |
否 |
String |
参数解释: 应用名称,支持模糊搜索。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线,长度为[1-56]个字符。 默认取值: 不涉及 |
summary |
否 |
String |
参数解释: 短描述,支持模糊搜索。 约束限制: 不涉及 取值范围: 长度为[1-1024]个字符。 默认取值: 不涉及 |
eihealth_project_names |
否 |
Array of strings |
参数解释: 空间名称列表,支持查询多个空间下的镜像。 约束限制: 每个空间名称长度为[1-512]个字符,最多支持100个空间名称。 取值范围: 不涉及 默认取值: 不涉及 |
labels |
否 |
Array of strings |
参数解释: 标签列表。 约束限制: 每个标签长度为[1-32]个字符,支持中文字母、数字、下划线和中划线,最多支持5个标签。 取值范围: 不涉及 默认取值: 不涉及 |
start_create_time |
否 |
Long |
参数解释: 最小创建时间。 约束限制: 不涉及 取值范围: 时间戳范围为[1000000000000, 9999999999999]。 默认取值: 不涉及 |
end_create_time |
否 |
Long |
参数解释: 最大创建时间。 约束限制: 不涉及 取值范围: 时间戳范围为[1000000000000, 9999999999999]。 默认取值: 不涉及 |
start_update_time |
否 |
Long |
参数解释: 最小更新时间。 约束限制: 不涉及 取值范围: 时间戳范围为[1000000000000, 9999999999999]。 默认取值: 不涉及 |
end_update_time |
否 |
Long |
参数解释: 最大更新时间。 约束限制: 不涉及 取值范围: 时间戳范围为[1000000000000, 9999999999999]。 默认取值: 不涉及 |
sort_by |
否 |
String |
参数解释: 排序规则,目前默认时间降序,支持根据create_time|update_time排序。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sort_dir |
否 |
String |
参数解释: 排序规则,目前默认时间降序。 约束限制: 不涉及 取值范围:
默认取值: DESC |
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000]。 约束限制: 不涉及 取值范围: [1,1000] 默认取值: 100 |
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000]。 约束限制: 不涉及 取值范围: [0,100000000] 默认取值: 0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
apps |
Array of AppDto objects |
参数解释: 应用列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
count |
Integer |
参数解释: 应用总条数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 应用ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
String |
参数解释: 应用名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_id |
String |
参数解释: 应用所属空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
eihealth_project_name |
String |
参数解释: 应用所属空间名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
version |
String |
参数解释: 应用版本。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
summary |
String |
参数解释: 应用简述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
description |
String |
参数解释: 应用描述。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
labels |
Array of strings |
参数解释: 应用标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
create_time |
String |
参数解释: 创建应用时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
update_time |
String |
参数解释: 更新应用时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
user_name |
String |
参数解释: 创建应用的用户名。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_project_name |
String |
参数解释: 源项目名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
source_resource_id |
String |
参数解释: 源资源ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
icon |
String |
参数解释: 图标base64编码。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询用户所属空间的应用列表。
https://{endpoint}/v1/{project_id}/eihealth-projects/apps
响应示例
状态码:200
OK
{ "apps" : [ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-app", "eihealth_project_id" : "project-id", "eihealth_project_name" : "project-name", "version" : "1.0.0", "summary" : "summary", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "user_name" : "gwj-test-01" } ], "count" : 1 }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。