获取变量列表

最近更新时间:2025-06-12 01:45:52

我的收藏

1. 接口描述

接口请求域名: lke.tencentcloudapi.com 。

查询自定义变量列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetVarList。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
AppBizId String 应用ID
示例值:1793260396881641472
VarIds.N Array of String 变量ID数组
示例值:["d125c28b-55db-4478-9066-6115ab97ee17"]
Keyword String 按变量名称关键词搜索
示例值:UserID
Offset Integer 起始偏移量(默认0)
示例值:0
Limit Integer 限定数量(默认15)
示例值:15
VarType String 按变量类型过滤,默认查询所有类型(STRING,INT,FLOAT,BOOL,OBJECT,ARRAY_STRING,ARRAY_INT,ARRAY_FLOAT,ARRAY_BOOL,ARRAY_OBJECT,FILE,DOCUMENT,IMAGE,AUDIO)
示例值:STRING

3. 输出参数

参数名称 类型 描述
Total Integer 变量总数
示例值:1
List Array of TaskFLowVar 变量信息列表
示例值:[{"VarId":"d125c28b-55db-4478-9066-6115ab97ee17","VarName":"UserID"}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取应用下的变量列表

获取应用下的变量列表

输入示例

POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetVarList
<公共请求参数>

{
    "AppBizId": "1793260396881641472"
}

输出示例

{
    "Response": {
        "List": [
            {
                "VarId": "55127e9e-6e9e-4c11-bcf8-b524959cd841",
                "VarName": "TimeIDUpdate",
                "VarDesc": "时间ID描述",
                "VarType": "STRING",
                "VarDefaultValue": "2025-05-14",
                "VarDefaultFileName": ""
            },
            {
                "VarId": "d125c28b-55db-4478-9066-6115ab97ee17",
                "VarName": "UserID",
                "VarDesc": "用户ID描述",
                "VarType": "STRING",
                "VarDefaultValue": "6213673423",
                "VarDefaultFileName": ""
            }
        ],
        "RequestId": "925208e7-46fa-43b3-a429-ddcbccad24f6",
        "Total": 2
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
MissingParameter 缺少参数错误。