文档

GetEnvVariableGroups - 查找环境所绑定的变量组列表详情

更新时间:

通过OpenAPI查找环境所绑定的变量组列表详情。

适用版本

企业专属版、企业标准版

服务接入点与授权信息

产品

资源

所需权限

应用交付

变量组

只读

请求语法

GET https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/envs/{envName}/variableGroups

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

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

请求参数

参数

类型

位置

是否必填

描述

示例值

appName

string

path

应用名。

my-web-service

envName

string

path

环境名。

dev

organizationId

string

path

组织 ID。

ec766e63aee3437d9a51f334d6exxxxx

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exxxxx/apps/my-web-service/envs/dev/variableGroups' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

array

-

object

变量组版本记录。

displayName

string

变量组展示名称。

dev-xxxx

name

string

变量组名称。

dev

revision

object

版本信息。

author

string

提交人。

1c83bd48e254405fb27297ee1fb8xxxx

commitTime

number

提交时间。

1726301443290

message

string

版本提交信息。

message-xxxx

refs

array[string]

关联信息。

repoMeta

object

仓库信息。

name

string

仓库名称。

my-repo

type

string

仓库类型:VARIABLE。

VARIABLE

sha

string

版本 sha 值。

c229f22024535638af41838daa43af1e6d46xxxx

type

string

类型,可能的值:[GLOBAL TEMPLATE APP]。

GLOBAL

vars

array

变量列表。

-

object

变量模型。

description

string

变量描述。

命名空间

key

string

变量键。

namespace

value

string

变量值。

default

返回示例

[
    {
        "displayName": "dev-xxxx",
        "name": "dev",
        "revision": {
            "author": "1c83bd48e254405fb27297ee1fb8xxxx",
            "commitTime": 1726301443290,
            "message": "message-xxxx",
            "refs": [
                
            ],
            "repoMeta": {
                "name": "my-repo",
                "type": "VARIABLE"
            },
            "sha": "c229f22024535638af41838daa43af1e6d46xxxx"
        },
        "type": "GLOBAL",
        "vars": [
            {
                "description": "命名空间",
                "key": "namespace",
                "value": "default"
            }
        ]
    }
]

错误码

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