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

创建全局变量

功能介绍

该API用于创建全局变量。

调试

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

URI

  • URI格式

    POST /v1.0/{project_id}/variables

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

var_name

String

全局变量名,名称只能包含数字、英文字母和下划线,但不能是纯数字,不能以下划线开头,且不能超过128字符。

var_value

String

全局变量值。

is_sensitive

Boolean

是否设置为敏感变量。默认为“false”。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

消息内容。

请求示例

创建一个全局变量,且该变量为敏感变量。

{
    "var_name": "string",
    "var_value": "string",
    "is_sensitive": true
}

响应示例

{
    "is_success": true,
    "message": "string"
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

创建变量成功。

400

输入参数无效。

错误码

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

表5 错误码

错误码

错误信息

DLI.0001

参数校验错误

DLI.0999

对象已存在错误

相关文档