GetChangeOrder - 读取部署单使用的物料和工单状态

服务接入点与授权信息

• 获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。

• 获取个人访问令牌，具体操作，请参见获取个人访问令牌。

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

请求语法

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

请求头

请求参数

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/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'

返回参数

返回示例

{
    "creator": "10df6011-2837-4fdb-ad92-356a679a60ca",
    "description": "正常发布日常需求",
    "endedAt": "2024-10-08T09:11:38Z",
    "gmtCreate": "2024-10-08T09:11:38Z",
    "jobs": [
        {
            "appOrchestration": {
                "app": {
                    "creatorId": "10df6011-2837-4fdb-ad92-356a679a60ca",
                    "description": "for java",
                    "favoured": false,
                    "gmtCreate": "2024-09-01 00:00:00",
                    "labelList": [
                        {
                            "displayName": "测试标签键",
                            "displayValue": "测试标签值",
                            "extraMap": {
                            },
                            "name": "demo-label",
                            "namespace": "default",
                            "value": "demo-label-value"
                        }
                    ],
                    "name": "my-web-app",
                    "type": "APP"
                },
                "componentList": [
                    {
                        "content": "---\napiVersion: v1\nkind: Service\nmetadata:\n  name: prod-sidecar-test-{{ .AppStack.envName }}\n  # 命名空间配置：\n  # 建议每个环境使用不同的Kubernetes集群命名空间，以便达到环境隔离效果\n  # 部署时云效会将占位符{{ .Values.namespace }}替换成右侧设置的实际值\n  namespace: {{ .Values.namespace }}\nspec:\n  selector:\n    run: prod-sidecar-test-{{ .AppStack.envName }}\n  ports:\n    - protocol: TCP\n      port: 80\n      targetPort: 8080",
                        "description": "示例描述",
                        "kind": "Service",
                        "name": "demo-service",
                        "priority": 1,
                        "type": "KUBERNETES"
                    }
                ],
                "creatorId": "app-builtin-creator-id",
                "description": "app-builtin-orchestration-description",
                "format": "MANIFEST",
                "gmtCreate": "2024-09-01 00:00:00",
                "gmtModified": "2024-09-01 00:00:00",
                "groupNameMap": {
                },
                "labelList": [
                    {
                        "displayName": "测试标签键",
                        "displayValue": "测试标签值",
                        "extraMap": {
                        },
                        "name": "demo-label",
                        "namespace": "default",
                        "value": "demo-label-value"
                    }
                ],
                "labelPolicy": "NONE",
                "modifierId": "app-builtin-modifier-id",
                "name": "app-builtin-orchestration-name",
                "placeholderList": [
                    {
                        "description": "内存限制",
                        "name": "memoryLimit",
                        "overridable": true,
                        "predefined": false,
                        "rsType": "KUBERNETES",
                        "rule": "",
                        "type": "string",
                        "value": "1024Mi",
                        "valueSource": "CONSTANT"
                    }
                ],
                "revision": {
                    "author": "10df6011-2837-4fdb-ad92-356a679a60ca",
                    "commitTime": "2024-09-01 00:00:00",
                    "message": "3t7cb880d20614038740e00e819dcdb13a37ce31",
                    "sha": "c229f22024535638af41838daa43af1e6d468116"
                },
                "sn": "app-builtin-orchestration-1",
                "storageType": "BUILTIN",
                "suitableResourceTypes": [
                    
                ],
                "syncSourceTemplate": {
                    "appTemplateName": "app-template-name",
                    "orchestrationSha": "app-template-version-sha"
                },
                "type": "AppBuiltInOrchestration"
            }
            "endedAt": "2024-10-08T09:11:38Z",
            "envName": "test",
            "sn": "40bfa492838047ce91870f52f6017ca6",
            "stages": [
                {
                    "endedAt": "2024-10-08T09:11:38Z",
                    "sn": "37bfa492838047ce91870f52f6017cb8",
                    "startedAt": "2024-10-08T09:11:38Z",
                    "state": "状态类型:RUNNING-运行中，SUSPENDED-暂停中，CANCELED-已取消，FAILED-已失败，SUCCESS-成功",
                    "tasks": [
                        {
                            "behavior": "Upsert",
                            "endedAt": "2024-10-08T09:11:38Z",
                            "errorMessage": "error-message",
                            "sn": "27bfa492838047ce91870f52f6017dj3",
                            "spec": "---
apiVersion: "v1"
kind: "Service"
metadata:
  name: "app-test"
  namespace: "ns-aaa"
  labels:
    devops.aliyun.com/app-name: "app-test"
    devops.aliyun.com/version: "20241202120555-308"
    devops.aliyun.com/org-id: "aaa-bbb-ccc"
    devops.aliyun.com/env-name: "test"
spec:
  selector:
    run: "app-test"
  ports:
  - name: "http-8080"
    protocol: "TCP"
    port: 8080
    targetPort: 8080",
                            "startedAt": "2024-10-08T09:11:38Z",
                            "state": "状态类型:RUNNING-运行中，SUSPENDED-暂停中，CANCELED-已取消，FAILED-已失败，SUCCESS-成功"
                        }
                    ]
                }
            ],
            "startedAt": "2024-10-08T09:11:38Z",
            "state": "状态类型:RUNNING-运行中，SUSPENDED-暂停中，CANCELED-已取消，FAILED-已失败，SUCCESS-成功",
            "type": "操作类型:Deploy-部署，Scale-扩缩，Rollback-回滚，Destroy-销毁,Revert-回退",
            "variableGroups": [
                {
                    "name": "test",
                    "revisionSha": "my-revision-sha",
                    "type": "类型：GLOBAL-全局,TEMPLATE-模板，APP-应用"
                }
            ]
        }
    ],
    "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 相关错误码。