ListVariableGroups - 获取变量组列表-云效(Alibaba Cloud DevOps)-阿里云帮助中心

通过 OpenAPI 获取变量组列表。

适用版本

中心版、Region版

服务接入点与授权信息

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

产品	资源	所需权限
流水线	变量组	只读

请求语法

中心版

GET https://{domain}/oapi/v1/flow/organizations/{organizationId}/variableGroups

Region版

GET https://{domain}/oapi/v1/flow/variableGroups

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	企业 Id。	5ebbc0228123212b59xxxxx
perPage	integer	query	否	每页数据条数，默认10，最大支持30。	10
page	integer	query	否	当前页，默认1。	1
pageSort	string	query	否	排序条件 ID。	ID
pageOrder	string	query	否	排序顺序 DESC 降序 ASC 升序。	DESC

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/flow/organizations/5ebbc0228123212b59xxxxx/variableGroups?perPage=10&page=1&pageSort=ID&pageOrder=DESC' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/flow/variableGroups?perPage=10&page=1&pageSort=ID&pageOrder=DESC' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
createTime	integer	创建时间。	1586863220000
creatorAccountId	string	创建人阿里云账号 id。	1111111111111
description	string	变量组描述。	变量组描述
id	integer	变量组 id。	1234
modifierAccountId	string	更新人阿里云账号 id。	1111111111111
name	string	变量组名称。	主机组
relatedPipelines	array
-	object
id	integer	关联的流水线 Id。	1586863220000
name	string	关联的流水线名称。	流水线
updateTime	integer	更新时间。	1586863220000
variables	array
-	object
isEncrypted	boolean	是否加密。	true
name	string	变量名。	name1
value	string	变量值。	value1

返回示例

[
    {
        "createTime": 1586863220000,
        "creatorAccountId": "1111111111111",
        "description": "变量组描述",
        "id": 1234,
        "modifierAccountId": "1111111111111",
        "name": "主机组",
        "relatedPipelines": [
            {
                "id": 1586863220000,
                "name": "流水线"
            }
        ],
        "updateTime": 1586863220000,
        "variables": [
            {
                "isEncrypted": true,
                "name": "name1",
                "value": "value1"
            }
        ]
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。	3
x-page	当前页。	2
x-per-page	每页数据条数。	10
x-prev-page	上一页。	1
x-total	总数据量。	100
x-total-pages	总分页数。	10

错误码

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