更新时间:2023-11-27 GMT+08:00
分享

查询所有全局变量

功能介绍

该API用于查询当前project下所有全局变量的信息。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v1.0/{project_id}/variables

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    表2 query参数说明

    参数名称

    是否必选

    参数类型

    说明

    limit

    Integer

    每页显示的返回信息的个数,默认值为“100”

    offset

    Integer

    偏移量,默认值为“0”

请求消息

无请求参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

count

Integer

全局变量数量。

global_vars

Array of Objects

全局变量信息。请参见表4

表4 global_vars参数说明

参数名称

是否必选

参数类型

说明

id

Long

全局变量ID。

var_name

String

全局变量名称。

var_value

String

全局变量值。

project_id

String

项目ID。

user_id

String

用户ID。

user_name

String

用户名。

is_sensitive

Boolean

是否设置为敏感变量。

create_time

Long

创建时间。

update_time

Long

更新时间。

请求示例

响应示例

{
    "is_success": true,
    "message": "string",
    "count": 0,
    "global_vars": [
        {
            "id": 0,
            "var_name": "string",
            "var_value": "string",
            "project_id": "string",
            "user_id": "string"
        }
    ]
}

状态码

表5 状态码

状态码

描述

200

查询变量成功。

400

输入参数无效。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

表6 错误码

错误码

错误信息

DLI.0001

参数校验错误

DLI.0999

服务端系统错误

相关文档