用户应用查询

更新时间:2026.07.21 10:41

功能说明

查询当前 API Key 所属租户下的应用列表,可按应用名称、分类、类型和创建时间筛选。

调用说明

地址:

https://www.shudacloud.com/api/open-api/platform/apps/query

方式:POST

接口编码:apps:query

鉴权方式:在请求 Header 中传入 X-API-Key。无需传入 tenant-id,服务端会根据 API Key 自动识别所属租户。

本页参数和返回值来自测试环境真实调试;请求示例中的域名已按生产环境填写。当前示例 API Key 仅在测试环境有效。

请求参数

名称 位置 类型 是否必选 示例值 描述
X-API-Key Header String qop_f9f5d23ff4c84e2aa513e37d08780022 开放平台 API Key
name Body String 审批打回流程 应用名称,模糊匹配
categoryCode Body String category_demo 应用分类编码
type Body Integer 0 应用类型
createTime Body Array ["2026-01-01 00:00:00","2026-12-31 23:59:59"] 创建时间范围

返回数据

名称 类型 示例值 描述
code Integer 0 业务状态码,0 表示成功
msg String 空字符串 业务提示信息
data Array 见返回示例 应用列表
data[].id String b7777c0c110504e68c43ce78ae8f096c 应用编号
data[].code String cd5151d248b24b1cac453a423648cb4f 应用编码
data[].name String 审批打回流程 应用名称
data[].type Integer 0 应用类型
data[].createTime Long 1784532381025 创建时间,毫秒时间戳

示例

请求示例

curl --request POST \
  --url "https://www.shudacloud.com/api/open-api/platform/apps/query" \
  --header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "审批打回流程"
}'

正常返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "b7777c0c110504e68c43ce78ae8f096c",
      "code": "cd5151d248b24b1cac453a423648cb4f",
      "name": "审批打回流程",
      "logoBg": "#2D8EFF",
      "logoColor": "#1F2329",
      "logoIcon": "Frame-18",
      "type": 0,
      "createTime": 1784532381025
    }
  ]
}

常见异常

业务状态码 说明
400 请求参数格式或必填参数校验失败
1002030001 未传入 X-API-Key
1002030002 API Key 无效
1002030003 API Key 已停用
1002030004 当前调用 IP 不在 API Key 白名单内
1002030006 当前 API Key 无权调用该接口

开放接口的业务异常通常仍返回 HTTP 200,请以响应体中的 code 判断调用是否成功。