文档

CreateGlobalVar - 创建全局变量组

更新时间:

创建全局变量组。

适用版本

企业专属版、企业标准版

服务接入点与授权信息

请求语法

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

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

organization-id-xxx

-

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

全局变量组信息。

message-xxx

name

string

body

全局变量组名称。

my-global-var-group

ownerId

string

body

全局变量组拥有者。

owner-id-xxx

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/appstack/organizations/anyOrganizationId/globalVars' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "content": [
            {
                "description": "命名空间",
                "key": "namespace",
                "value": "default"
            }
        ],
        "displayName": "my-display-name",
        "message": "message-xxx",
        "name": "my-global-var-group",
        "ownerId": "owner-id-xxx"
    }'

返回参数

参数

类型

描述

示例值

-

object

全局变量组。

content

array

全局变量组变量列表。

-

object

变量模型。

description

string

变量描述。

命名空间

key

string

变量键。

namespace

value

string

变量值。

default

creator

string

全局变量组创建者。

creator-id-xxx

displayName

string

全局变量组显示名称。

my-display-name

gmtCreate

string

全局变量组创建时间。

2024-01-01 00:00:00

gmtModified

string

全局变量组修改时间。

2024-01-01 00:00:00

modifier

string

全局变量组修改者。

modifier-id-xxx

name

string

全局变量组名称。

my-global-var-group

revision

object

版本信息。

author

string

提交人。

user-xxxx

commitTime

integer

提交时间。

1722250824321

message

string

版本提交信息。

message-xxxx

refs

array[string]

关联信息。

repoMeta

object

仓库信息。

name

string

仓库名称。

my-repo-name

type

string

仓库类型。

VARIABLE

sha

string

版本 sha 值。

sha-xxxxx

返回示例

{
    "content": [
        {
            "description": "命名空间",
            "key": "namespace",
            "value": "default"
        }
    ],
    "creator": "creator-id-xxx",
    "displayName": "my-display-name",
    "gmtCreate": "2024-01-01 00:00:00",
    "gmtModified": "2024-01-01 00:00:00",
    "modifier": "modifier-id-xxx",
    "name": "my-global-var-group",
    "revision": {
        "author": "user-xxxx",
        "commitTime": 1722250824321,
        "message": "message-xxxx",
        "refs": [
            
        ],
        "repoMeta": {
            "name": "my-repo-name",
            "type": "VARIABLE"
        },
        "sha": "sha-xxxxx"
    }
}

错误码

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