GetAppConfig - 获取配置信息

获取app配置。

接口说明

前提条件

已开通百炼服务和通义点金服务。

获取到 workspaceId:获取 workspace 标识

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dianjin:GetAppConfigget
*全部资源
*

请求语法

GET /{workspaceId}/api/app/config HTTP/1.1

请求参数

名称类型必填描述示例值
workspaceIdstring

路径参数,业务空间 id

llm-xxxxx

返回参数

名称类型描述示例值
object

ResultCode

costlong

耗时

null
dataobject

返回数据

embeddingTypeListarray<object>

embedding 类型列表

embeddingTypeListobject

k-v 对

string

value

DashScope
frontendConfigobject

前端配置

boolean

是否开启

true
libraryDocumentStatusListarray<object>

文档库文档状态列表

libraryDocumentStatusListobject

k-v 对

string

value

Completed
llmHelperTypeListarray<object>

大模型类型列表

llmHelperTypeListobject

k-v 对

string

value

qwen-max
textIndexCategoryListarray

文本索引类别列表

textIndexCategoryListstring

文本索引类别

ElasticSearch
vectorIndexCategoryListarray

向量索引类别列表

vectorIndexCategoryListstring

向量索引类别

ADB
dataTypestring

数据类型

null
errCodestring

错误码

0
messagestring

错误信息

None
requestIdstring

请求 id

EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258
successboolean

是否成功

True
timestring

时间戳

2024-04-24 11:54:34

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": {
    "embeddingTypeList": [
      {
        "key": "DashScope"
      }
    ],
    "frontendConfig": {
      "key": true
    },
    "libraryDocumentStatusList": [
      {
        "key": "Completed"
      }
    ],
    "llmHelperTypeList": [
      {
        "key": "qwen-max"
      }
    ],
    "textIndexCategoryList": [
      "ElasticSearch"
    ],
    "vectorIndexCategoryList": [
      "ADB"
    ]
  },
  "dataType": "null",
  "errCode": "0",
  "message": "None",
  "requestId": "EF4B5C9B-3BC8-5171-A47B-4C5CF3DC3258",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

访问错误中心查看更多错误码。