文档首页/ 数据湖探索 DLI/ API参考/ 全局变量相关API/ 修改全局变量 - UpdateGlobalVariable
更新时间:2025-10-28 GMT+08:00
分享

修改全局变量 - UpdateGlobalVariable

功能介绍

该API用于修改全局变量。

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限及授权项说明
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    Action

    访问级别

    Access Level

    资源类型(*为必须)

    Resource Type (*: required)

    条件键

    Condition Key

    别名

    Alias

    依赖的授权项

    Dependencies

    dli:variable:update

    Write

    variable *

    -

    -

    -

URI

  • URI格式

    PUT /v1.0/{project_id}/variables/{var_name}

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    var_name

    String

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

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

var_value

String

全局变量值。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

消息内容。

请求示例

修改敏感变量的取值。

{
    "var_value": "string"
}

响应示例

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

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

修改变量成功。

400

输入参数无效。

错误码

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

表5 错误码

错误码

错误信息

DLI.0001

参数校验错误

DLI.0999

服务端系统错误

DLI.12004

作业不存在请检查原因或者创建一个新作业

相关文档