GetChangeOrder - 读取部署单使用的物料和工单状态-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

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

产品	资源	所需权限
应用交付	部署单	只读

请求语法

中心版

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

Region版

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

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
appName	string	path	是	应用名。	my-web-service
changeOrderSn	string	path	是	部署单编号。	66c0c9fffeb86b450c199fcd
organizationId	string	path	是：中心版否：Region版	组织 ID。	ec766e63aee3437d9a51f334d6exe671

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/my-web-service/changeOrders/66c0c9fffeb86b450c199fcd' \
  -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-web-service/changeOrders/66c0c9fffeb86b450c199fcd' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	object
creator	string	创建人。	10df6011-2837-4fdb-ad92-356a679a60ca
description	string	描述。	正常发布日常需求
endedAt	string	部署单结束时间。	2024-10-08T09:11:38Z
gmtCreate	string	部署单最后修改时间。	2024-10-08T09:11:38Z
jobs	array	环境部署单列表。
-	object	环境部署单概要信息。
envName	string	环境名称。
sn	string	作业单号。
state	string	作业状态。
name	string	部署单名称。	20241008171130-部署
sn	string	部署单唯一标识。	bc62b3e953714aa8be431f47b9c9b72a
startedAt	string	部署单开始时间。	2024-10-08T09:11:38Z
state	string	部署单状态，可能的值：[INIT PREPARING RUNNING SUSPENDED CANCELED SUCCESS FAILED]。	操作类型:RUNNING-运行中，SUSPENDED-暂停中，CANCELED-已取消，FAILED-已失败，SUCCESS-成功
type	string	部署单类型，可能的值：[Deploy Scale Rollback Destroy]。	操作类型:Deploy-部署，Scale-扩缩，Rollback-回滚，Destroy-销毁
version	string	使用版本。	20241008171130-762

返回示例

{
    "creator": "10df6011-2837-4fdb-ad92-356a679a60ca",
    "description": "正常发布日常需求",
    "endedAt": "2024-10-08T09:11:38Z",
    "gmtCreate": "2024-10-08T09:11:38Z",
    "jobs": [
        {
            "envName": "",
            "sn": "",
            "state": ""
        }
    ],
    "name": "20241008171130-部署",
    "sn": "bc62b3e953714aa8be431f47b9c9b72a",
    "startedAt": "2024-10-08T09:11:38Z",
    "state": "操作类型:RUNNING-运行中，SUSPENDED-暂停中，CANCELED-已取消，FAILED-已失败，SUCCESS-成功",
    "type": "操作类型:Deploy-部署，Scale-扩缩，Rollback-回滚，Destroy-销毁",
    "version": "20241008171130-762"
}

错误码

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