获取应用列表
更新时间:2025-05-13
接口描述
本接口用于查询应用列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 只读访问千帆大模型平台预测服务的权限:QianfanServiceReadAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
Bash
1POST /v2/application?Action=DescribeApplications HTTP/1.1
2Host: qianfan.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "protocolVersion": 2
8}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribeApplications |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
maxKeys | int | 否 | 请求列表长度,说明: (1)默认值是10 (2)列表长度最大为100,如果指定的值大于100,按100操作 |
pageReverse | bool | 否 | 是否倒序,默认为false |
creator | List<string> | 否 | 创建人,说明:填写此参数,表示按创建人进行筛选 |
protocolVersion | int | 否 | 推理接口版本,默认为2 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
appList | List<object> | 应用列表 |
pageInfo | object | 分页信息 |
appList说明
名称 | 类型 | 描述 |
---|---|---|
appName | string | 应用名称 |
appId | string | 应用ID |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置,说明:若是从第一条数据查询,该字段返回值为空 |
maxKeys | int | 请求返回的列表长度,说明: (1)默认值是10 (2)列表长度最大为100,如果指定的值大于100,按100操作 |
isTruncated | bool | 指明是否只返回了部分数据,说明: · false:表示本次已经返回所有结果 · true:表示本次还没有返回所有结果 |
nextMarker | string | 当isTruncated为true时,返回该字段,作为下次查询marker的值 |
请求示例
Bash
1# 替换下列示例中的Authorization值
2curl --location 'https://qianfan.baidubce.com/v2/application?Action=DescribeApplications' \
3--header 'Authorization: bce-auth-v1/047ab24*****b42a4d2e3e28b1ac/2025-04-24T05:03:37Z/18000/host/6ee35c7a9633a7faed591088e53df*****b9b91699fdf890ea5f5ad41' \
4--header 'Content-Type: application/json' \
5--data '{
6 "protocolVersion": 2
7}'
响应示例
JSON
1{
2 "requestId": "c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0",
3 "result": {
4 "appList": [
5 {
6 "dev_app_id": "app-Oy***0Gr",
7 "name": "app_test_v2"
8 },
9 {
10 "dev_app_id": "app-p***H",
11 "name": "app_jsx1_v2"
12 },
13 ........
14 ],
15 "pageInfo": {
16 "marker": "",
17 "maxKeys": 10,
18 "isTruncated": true,
19 "nextMarker": "app-Z****JP"
20 }
21 }
22}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
Plain Text
1{
2 "requestId":"6ba7b810-xxxc04fd430c8",
3 "code":"AccessDenied",
4 "message":"Access denied."
5}
更多错误码,请查看错误码说明。