VariableList - 查看变量列表
更新时间:2024-11-07
API访问域名
请求方式 | GET |
---|---|
base url | https://keyue.cloud.baidu.com |
后缀接口 | /open/v1/api/v2/dialog/variable |
Authentication | token为API Key |
说明
无
请求参数
Header参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
Content-Type | string | 是 | 内容类型 | 固定值:application/json |
token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考:准备工作 |
uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考:准备工作 |
username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考:准备工作 |
Parameter参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
content | string | 否 | 变量名称 | 根据变量名模糊查询 |
pn | integer | 否 | 页数 | 可以根据这个字段分页查询 |
ps | integer | 否 | 每页数据条数 |
Body参数
无
响应参数
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
time | integer | 是 | 时间 | 1716985128196 |
data | object | 是 | 数据 | 数据对象 |
data \ total | integer | 是 | 数据条数 | 2 |
data \ pn | integer | 是 | 页数 | 1 |
data \ ps | integer | 是 | 每页数据条数 | 999 |
data \ list | array | 是 | 数据列表 | |
data \ list \ id | string | 是 | 全局变量ID | 826868f2-25d8-4686-9c27-8ec44f57ee2d |
data \ list \ name | string | 是 | 全局变量名称 | test_add |
data \ list \ description | string | 是 | 全局变量注释 | 测试添加... |
data \ list \ createdUsername | string | 是 | 全局变量创建用户名称 | pnstest3 |
data \ list \ lastEditUsername | string | 是 | 全局变量最新编辑用户名称 | pnstest3 |
data \ list \ created | string | 是 | 创建时间 | 2024-07-29 14:15:56 |
data \ list \ updated | string | 是 | 更新时间 | 2024-07-29 14:15:56 |
data \ list \ version | integer | 是 | 编辑版本 | 1 |
data \ list \ type | integer | 是 | 变量类型,0表示用户变量,1表示系统内置变量 | 0 |
code | integer | 是 | 状态码 | 200 |
msg | string | 是 | 状态信息 | OK |
请求示例
curl --location 'http://keyue-test.cloud.baidu.com/open/v1/api/v2/dialog/variable?ps=10&pn=1&content=' \
--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
--header 'uid: dd6283a283df42998bab14607e23f38d' \
--header 'username: xxxxxxxx' \
--header 'Content-Type: application/json'
响应示例
{
"time": 1722237613140,
"data": {
"total": 2,
"pn": 1,
"ps": 999,
"list": [
{
"id": "81dea988-2427-4609-b4f9-3770b0b61867",
"name": "test_add",
"description": "测试添加....",
"status": 0,
"createdUsername": "xxxxxxxx",
"lastEditUsername": "xxxxxxxx",
"created": "2024-07-29 14:41:48",
"updated": "2024-07-29 14:52:17",
"version": 2,
"instructions": [],
"type": 0
},
{
"id": "029ac66c-994f-4e2e-a3ca-db0fe11496a0",
"name": "time",
"description": "获取当前时间,格式HH:mm:ss",
"status": 0,
"createdUsername": "system",
"lastEditUsername": "system",
"created": "2024-06-12 17:37:23",
"updated": "2024-06-12 17:37:23",
"version": 1,
"instructions": [],
"type": 1
}
]
},
"code": 200,
"msg": "OK"
}