查找应用下所有的研发流程-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

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

产品	资源	所需权限
应用交付	研发流程	只读

请求语法

中心版

GET https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/releaseWorkflows

Region版

GET https://{domain}/oapi/v1/appstack/apps/{appName}/releaseWorkflows

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
appName	string	path	是	应用名。	my-app
organizationId	string	path	是：中心版否：Region版	组织 ID。	ec766e63xxxxx334d6exe671

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/appstack/organizations/ec766e63xxxxx334d6exe671/apps/my-app/releaseWorkflows' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/appstack/apps/my-app/releaseWorkflows' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数 #1

参数	类型	描述	示例值
-	array
-	object	研发流程。
appName	string	应用名。	my-web-app
name	string	名称。	my-release-workflow
note	string	公告。	my-note
order	string	排序。	1
releaseStages	array	研发阶段列表。
-	object	流程阶段。
appName	string	应用名。	my-web-app
labels	array	标签列表。
-	object	AppStack 标签。
displayName	string	标签的展示名，用于描述性的场景，不参与标签匹配。	测试标签键
displayValue	string	标签的展示值，用于描述性的场景，不参与标签匹配。	测试标签值
extraMap	object	标签扩展属性 map，可在定义标签时用于存储自定义的扩展属性字段。	{}
name	string	标签名，仅允许包含小写字母、中划线和数字，且开头、结尾均为小写字母或数字。	demo-label
namespace	string	标签命名空间，决定了标签的作用域。	default
value	string	标签值，仅允许包含小写字母、中划线和数字，且开头、结尾均为小写字母或数字。	demo-label-value
name	string	名称。	my-stage
order	string	阶段顺序。	1
pipeline	object	流水线 V1版本。
engineType	string	引擎类型。
pipeline	object
plugins	array
refObjectList	array[string]
sn	string	唯一序列号。	sn-xxxx
variableGroups	array	变量组列表。
-	object	通用变量组模型。
displayName	string	变量组显示名。	开发变量组
name	string	变量组标识。	dev
type	string	变量组类型。	GLOBAL
sn	string	唯一标识 sn。	sn-xxx
type	string	研发流程类型，可能的值：[CR APP_RELEASE]。	CR

返回参数 #2

参数	类型	描述	示例值
-	array
-	object	研发流程
appName	string	应用名	my-web-app
name	string	名称	my-release-workflow
note	string	公告	my-note
order	string	排序	1
releaseStages	array	研发阶段列表
-	object	流程阶段
appName	string	应用名	my-web-app
labels	array	标签列表
-	object	AppStack 标签
displayName	string	标签的展示名，用于描述性的场景，不参与标签匹配	测试标签键
displayValue	string	标签的展示值，用于描述性的场景，不参与标签匹配	测试标签值
extraMap	object	标签扩展属性 map，可在定义标签时用于存储自定义的扩展属性字段	{}
name	string	标签名，仅允许包含小写字母、中划线和数字，且开头、结尾均为小写字母或数字	demo-label
namespace	string	标签命名空间，决定了标签的作用域	default
value	string	标签值，仅允许包含小写字母、中划线和数字，且开头、结尾均为小写字母或数字	demo-label-value
name	string	名称	my-stage
order	string	阶段顺序	1
pipeline	object	流水线V2版本
engineType	string	引擎类型
pipeline	object
plugins	array
refObjectList	array[string]
sn	string	唯一序列号	sn-xxxx
variableGroups	array	变量组列表
-	object	通用变量组模型
displayName	string	变量组显示名	开发变量组
name	string	变量组标识	dev
type	string	变量组类型	GLOBAL
sn	string	唯一标识sn	sn-xxx
type	string	研发流程类型，可能的值：[CR APP_RELEASE]	CR

返回示例 #1

[
    {
        "appName": "my-web-app",
        "name": "my-release-workflow",
        "note": "my-note",
        "order": "1",
        "releaseStages": [
            {
                "appName": "my-web-app",
                "labels": [
                    {
                        "displayName": "测试标签键",
                        "displayValue": "测试标签值",
                        "extraMap": {},
                        "name": "demo-label",
                        "namespace": "default",
                        "value": "demo-label-value"
                    }
                ],
                "name": "my-stage",
                "order": "1",
                "pipeline": {
                    "engineType": "",
                    "pipeline": {
                    },
                    "plugins": [
                    ],
                    "refObjectList": [
                    ]
                }
                "releaseWorkflowSn": "1484e1faxxxxxxx52607b2eb345",
                "sn": "sn-xxxx",
                "variableGroups": [
                    {
                        "displayName": "开发变量组",
                        "name": "dev",
                        "type": "GLOBAL"
                    }
                ]
            }
        ],
        "sn": "sn-xxx",
        "type": "CR"
    }
]

返回示例 #2

[
    {
        "appName": "my-web-app",
        "name": "my-release-workflow",
        "note": "my-note",
        "order": "1",
        "releaseStages": [
            {
                "appName": "my-web-app",
                "labels": [
                    {
                        "displayName": "测试标签键",
                        "displayValue": "测试标签值",
                        "extraMap": {},
                        "name": "demo-label",
                        "namespace": "default",
                        "value": "demo-label-value"
                    }
                ],
                "name": "my-stage",
                "order": "1",
                "pipeline": {
                    "engineType": "",
                    "pipeline": {
                    },
                    "plugins": [
                    ],
                    "refObjectList": [
                    ]
                }
                "releaseWorkflowSn": "1484e1faxxxxxxx52607b2eb345",
                "sn": "sn-xxxx",
                "variableGroups": [
                    {
                        "displayName": "开发变量组",
                        "name": "dev",
                        "type": "GLOBAL"
                    }
                ]
            }
        ],
        "sn": "sn-xxx",
        "type": "CR"
    }
]

错误码

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