UpdateVariableGroup - 更新变量组-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
应用交付	变量组	读写

请求语法

中心版

PUT https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/variableGroup/{variableGroupName}

Region版

PUT https://{domain}/oapi/v1/appstack/apps/{appName}/variableGroup/{variableGroupName}

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
appName	string	path	是	应用名。	my-web-service
variableGroupName	string	path	是	变量组名。	dev
organizationId	string	path	是：中心版否：Region版	组织 ID。	ec766e63aee3437d9a51f334d6exe671
-	object	body	否	变量组模型。
branchName	string	body	否	版本分支，默认 master。	master
displayName	string	body	否	变量组展示名。	dev
fromRevisionSha	string	body	是	变量组版本号。	1.0.0
message	string	body	否	变量组描述信息。	message
name	string	body	否	变量组唯一名。	dev
vars	array	body	否	变量列表。
-	object	body	否	变量模型。
description	string	body	否	变量描述。	命名空间
key	string	body	否	变量键。	namespace
value	string	body	否	变量值。	default

请求示例

中心版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/my-web-service/variableGroup/dev' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "branchName": "master",
        "displayName": "dev",
        "fromRevisionSha": "1.0.0",
        "message": "message",
        "name": "dev",
        "vars": [
            {
                "description": "命名空间",
                "key": "namespace",
                "value": "default"
            }
        ]
    }'

Region版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/appstack/apps/my-web-service/variableGroup/dev' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "branchName": "master",
        "displayName": "dev",
        "fromRevisionSha": "1.0.0",
        "message": "message",
        "name": "dev",
        "vars": [
            {
                "description": "命名空间",
                "key": "namespace",
                "value": "default"
            }
        ]
    }'

返回参数

参数	类型	描述	示例值
-	object	变量组版本记录。
displayName	string	变量组展示名称。	dev-xxxx
name	string	变量组名称。	dev
revision	object	版本信息。
author	string	提交人。	10df6011-2837-4fdb-ad92-356a679a60ca
commitTime	number	提交时间。	1.63e+12
message	string	版本提交信息。	message-xxxx
refs	array[string]	关联信息。
repoMeta	object	仓库信息。
name	string	仓库名称。	my-repo
type	string	仓库类型。	VARIABLE
sha	string	版本 sha 值。	a80102ee37cca462a23865e7a3e66ac1ca032a5c
type	string	类型，可能的值：[GLOBAL TEMPLATE APP]。	GLOBAL
vars	array	变量列表。
-	object	变量模型。
description	string	变量描述。	命名空间
key	string	变量键。	namespace
value	string	变量值。	default

返回示例

{
    "displayName": "dev-xxxx",
    "name": "dev",
    "revision": {
        "author": "10df6011-2837-4fdb-ad92-356a679a60ca",
        "commitTime": 1.63e+12,
        "message": "message-xxxx",
        "refs": [
            
        ],
        "repoMeta": {
            "name": "my-repo",
            "type": "VARIABLE"
        },
        "sha": "a80102ee37cca462a23865e7a3e66ac1ca032a5c"
    },
    "type": "GLOBAL",
    "vars": [
        {
            "description": "命名空间",
            "key": "namespace",
            "value": "default"
        }
    ]
}

错误码

访问错误码中心查看 API 相关错误码。