跳到主要内容

应用配置信息查询

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/customer/apps/search/<customerId>
提示

<customerId> 需替换为您的账户 ID，可在【控制台】-【账户管理】页面查看, 若对此有任何问题，请联系客户经理。

注意

这里使用的是 customerId, 不是 secretId

1.2 请求方法​

POST

1.3 请求头​

请求头名称取值是否必需示例说明
Content-Typeapplication/json是Content-Type: application/json请求数据类型为 JSON
X-API-Key<API Key>是X-API-Key: <API Key>API Key 用于接口鉴权。请访问控制台 - 数字证书 获取 API Key

1.4 请求参数​

参数名称类型是否必需说明
secretIdsArray<String>否应用 ID (SecretId) , 最多为 10 个, 若指定则只返回该范围中的应用单页返回所有结果，否则则按 page 和 limit 分页返回
pageInt否第几页, 从 1 开始, 默认为 1
limitInt否返回条目数限制, 默认为 5, 最大为 50, 若遇到超时错误，请酌情减少 limit

1.5 请求示例​

1.5.1 指定 secretIds 范围​
{
  "secretIds": [
    "<secretId1>",
    "<secretId2>"
  ]
}
1.5.2 分页查询​
{
  "page": 1,
  "limit": 5
}

2. 同步响应​

3.1 响应参数说明 🔥🔥​

参数名称类型说明
signatureString

同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过 图普公钥 进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：

  1. 取 json 字段内容为 SignString；
  2. 将 signature 字段内容进行 Base64 解码，得到 RawSignature；
  3. 使用图普公钥以 SHA256 算法验证 RawSignature 及 SignString
jsonString

同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。

  • 字段内容示例：{\"code\":0, \"message\":\"success\"}；
  • 字段详见下述 JSON 参数说明；
  • 为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

JSON 参数说明​

参数名称类型是否必有说明
codeInt是请求状态码，详见 业务状态码
messageString是状态信息
timestampInt是当前服务器的 Unix 时间戳
nonceFloat是随机数（建议使用 Unix 时间戳或若干位随机整数）
hasNextBoolean是是否存在下一页
totalInt是结果总数
secretsArray<Secret>是应用信息，详见 Secret 说明

Secret 说明​

参数名称类型是否可能为空说明
secretIdString否应用 （SecretId)
customerIdString否客户 ID
appNameString否应用名称
operatorNameString否账户邮箱
regionString否地域, 国内: internal, 国外: overseas
entityTypeString否实体类型, 详见 EntityType 说明
fileSizeLimitInt否上传文件限制大小
maxFileIntOfSingleRequestInt否单次请求文件数量限制
activeQuantityLimitInt否在线数量限制
speechFragmentDurationInt否语音切片时长
returnSummaryBoolean否是否返回汇总结果
tasksArray<Task>否任务列表，详见 Task 说明
rateLimitInt否QPS 数量限制
statusInt否应用（SID）状态, 关闭: -1, 启用: 0, 暂停:1

Task 说明​

参数名称类型是否可能为空说明
taskIdString否任务 ID
statusInt否状态, 用户测试: 10, 正式使用:11
taskNameString否任务名称

EntityType 说明​

实体类型说明
imageCommon普通图片
imageAsync异步图片
imageFaceComparison图片人脸比对
imageLivenessAuth图片活体认证
speechCommon普通语音
speechAsync异步语音
recordSpeechAsync异步点播语音
liveSpeechAsync异步直播语音
videoCommon普通视频
videoSync同步视频
videoAsync异步视频
textCommon普通文本
textAsync异步文本

2.3 响应示例​

{
  "code": 0,
  "message": "success",
  "nonce": 138116,
  "hasNext": false,
  "total": 1,
  "secrets": [
    {
      "secretId": "xxxxxxxxxxxxxxxxxxxxxxxx",
      "customerId": "xxxxxxxxxxxxxxxxxxxxxxxx",
      "appName": "xxxxxx",
      "operatorName": "xxxxxxxxxxxxxxxxxx",
      "region": "internal",
      "entityType": "imageCommon",
      "fileSizeLimit": 1,
      "maxFileIntOfSingleRequest": 10,
      "activeQuantityLimit": 30,
      "speechFragmentDuration": 10,
      "returnSummary": true,
      "tasks": [
        {
          "taskId": "54bcfc6c329af61034f7c2fc",
          "taskName": "色情识别",
          "status": 10
        }
      ],
      "rateLimit": 10,
      "status": 0
    }
  ],
  "timestamp": 1718795309
}