查询应用
功能介绍
查询应用:
体现应用等相关信息,丰富总览页面信息,提升用户运维效率。
请求参数limit(查询条数)必填,单次最大查询条数:500。
返回信息包括:应用ID,应用名称,应用CODE,应用描述,租户ID,父节点ID,应用层级路径,是否为收藏应用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/applications
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id_list |
否 |
Array of strings |
参数解释: 应用id组成的id列表。 约束限制: 不涉及。 取值范围: 列表,大小0到100。 默认取值: 不涉及 |
parent_id |
否 |
String |
参数解释: 父节点id。 约束限制: 不涉及。 取值范围: 查询自己创建的项目,则此处返回所属区域的项目ID。 默认取值: 不涉及 |
name_like |
否 |
String |
参数解释: 应用名称模糊匹配。 约束限制: 不涉及。 取值范围: 字符串,长度1~50个字符之间。 默认取值: 不涉及。 |
code |
否 |
String |
参数解释: 应用code。 约束限制: 不涉及。 取值范围: 字符串,长度在3~50个字符之间。 默认取值: 不涉及。 |
marker |
否 |
String |
参数解释: 分页参数,上一页请求最后一个id。 约束限制: 不涉及。 取值范围: 字符串,长度24个字符。 默认取值: 不涉及 |
limit |
是 |
Integer |
参数解释: 分页查询每页显示的条目数量。 约束限制: 不涉及。 取值范围: 自定义,在1-500范围。 默认取值: 不涉及。 |
page_no |
否 |
Integer |
参数解释: 分页页码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
is_collection |
否 |
Boolean |
参数解释: 是否收藏。 约束限制: 不涉及。 取值范围: 默认取值: 默认未收藏。 |
is_root |
否 |
Boolean |
参数解释: 是否根应用。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
offset |
否 |
String |
参数解释: 分页查询偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 0-2147483647。 默认取值: 0。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Array of data objects |
参数解释: 应用列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 应用id。 取值范围: 不涉及。 |
name |
String |
参数解释: 应用名称。 取值范围: 由中文、英文字母、数字、中划线、下划线组成,长度在3~50个字符之间。 |
code |
String |
参数解释: 应用code。 取值范围: 不涉及。 |
domain_id |
String |
参数解释: 租户id。 取值范围: 不涉及。 |
parent_id |
String |
参数解释: 父节点id。 取值范围: 不涉及。 |
description |
String |
参数解释: 描述信息。 取值范围: 不涉及。 |
path |
String |
参数解释: 应用path路径。 取值范围: 由应用id用.拼接。 |
is_collection |
Boolean |
参数解释: 应用是否被收藏。 取值范围: |
create_time |
String |
参数解释: 创建时间,参考ISO8601标准格式。 取值范围: 不涉及。 |
update_time |
String |
参数解释: 修改时间,参考ISO8601标准格式。 取值范围: 不涉及。 |
请求示例
某区域为例,查询该区域下面一条应用详细信息。
GET https://{endpoint}/v1/applications?id_list={id_list}&parent_id={parent_id}&name_like={name_like}&code={code}&marker={marker}&limit={limit} { "id_list" : [ 1, 2 ], "name_like" : "coc", "limit" : 200 }
响应示例
状态码:200
应用列表详细信息。
{ "data" : [ { "id" : "64898bf60224b9730ccb577f", "name" : "testApplication", "code" : "testApplication", "description" : "dfdfdfd66", "domain_id" : "dc2d76541f754d68a4c8d150262d92c2", "parent_id" : null, "path" : "64898bf60224b9730ccb577f", "is_collection" : null, "create_time" : "2023-06-14T09:44:22.116+00:00", "update_time" : "2025-01-21T03:51:02.767+00:00" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
应用列表详细信息。 |
错误码
请参见错误码。