CreateGlobalVar - 创建全局变量组-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

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

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

请求语法

中心版

POST https://{domain}/oapi/v1/appstack/organizations/{organizationId}/globalVars

Region版

POST https://{domain}/oapi/v1/appstack/globalVars

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	组织 ID。	ec766e63aee3437d9a51f334d6exe671
-	object	body	否	创建全局变量组请求。
content	array	body	否	变量列表。
-	object	body	否	变量模型。
description	string	body	否	变量描述。	命名空间
key	string	body	否	变量键。	namespace
value	string	body	否	变量值。	default
displayName	string	body	是	全局变量组显示名称。	my-display-name
message	string	body	否	全局变量组信息。	env config for og
name	string	body	是	全局变量组名称。	my-global-var-group
ownerId	string	body	否	全局变量组拥有者。	10df6011-2837-4fdb-ad92-356a679a60ca

请求示例

中心版

curl -X 'POST' \
  'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/globalVars' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "content": [
            {
                "description": "命名空间",
                "key": "namespace",
                "value": "default"
            }
        ],
        "displayName": "my-display-name",
        "message": "env config for og",
        "name": "my-global-var-group",
        "ownerId": "10df6011-2837-4fdb-ad92-356a679a60ca"
    }'

Region版

curl -X 'POST' \
  'https://{domain}/oapi/v1/appstack/globalVars' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "content": [
            {
                "description": "命名空间",
                "key": "namespace",
                "value": "default"
            }
        ],
        "displayName": "my-display-name",
        "message": "env config for og",
        "name": "my-global-var-group",
        "ownerId": "10df6011-2837-4fdb-ad92-356a679a60ca"
    }'

返回参数

参数	类型	描述	示例值
-	object	全局变量组。
content	array	全局变量组变量列表。
-	object	变量模型。
description	string	变量描述。	命名空间
key	string	变量键。	namespace
value	string	变量值。	default
creator	string	全局变量组创建者。	10df6011-2837-4fdb-ad92-356a679a60ca
displayName	string	全局变量组显示名称。	my-display-name
gmtCreate	string	全局变量组创建时间。	2024-01-01 00:00:00
gmtModified	string	全局变量组修改时间。	2024-01-01 00:00:00
modifier	string	全局变量组修改者。	10df6011-2837-4fdb-ad92-356a679a60ca
name	string	全局变量组名称。	my-global-var-group
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

返回示例

{
    "content": [
        {
            "description": "命名空间",
            "key": "namespace",
            "value": "default"
        }
    ],
    "creator": "10df6011-2837-4fdb-ad92-356a679a60ca",
    "displayName": "my-display-name",
    "gmtCreate": "2024-01-01 00:00:00",
    "gmtModified": "2024-01-01 00:00:00",
    "modifier": "10df6011-2837-4fdb-ad92-356a679a60ca",
    "name": "my-global-var-group",
    "revision": {
        "author": "10df6011-2837-4fdb-ad92-356a679a60ca",
        "commitTime": 1.63e+12,
        "message": "message-xxxx",
        "refs": [
            
        ],
        "repoMeta": {
            "name": "my-repo",
            "type": "VARIABLE"
        },
        "sha": "a80102ee37cca462a23865e7a3e66ac1ca032a5c"
    }
}

错误码

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