使用GetAppOrchestrationExport OpenAPI导出应用编排-云效-阿里云-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

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

产品	资源	所需权限
应用交付	应用编排	只读

请求语法

中心版

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

Region版

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

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
appName	string	path	是	应用名。	my-web-service
organizationId	string	path	是：中心版否：Region版	组织 ID。	bd9e3c6d-xxxxxxxc5e26f1ed0f0
envName	string	query	否	环境名称。	dev
profileNames	string	query	否	应用变量组名称，非必填，多个用逗号分隔。	dev,test
renderType	string	query	是	渲染类型，必填，值必须为 MANIFEST 和 CHARTS，MANIFEST 为原生 YAML，CHARTS 为 Helm Charts。	MANIFEST
suitableResourceType	string	query	是	适用资源类型，必填，值必须为 KUBERNETES 和 HOST，KUBERNETES 为 Kubernetes 部署，HOST 为主机部署。	KUBERNETES
sha	string	query	是	编排版本信息 commit sha 值，必填，可参考 API ListAppOrchestration 获取。	d23ccbd926c31e3cxxxxxxx3f22c4548b93b1426e

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/appstack/organizations/bd9e3c6d-xxxxxxxc5e26f1ed0f0/apps/my-web-service/orchestrations:export?envName=dev&profileNames=dev,test&renderType=MANIFEST&suitableResourceType=KUBERNETES&sha=d23ccbd926c31e3cxxxxxxx3f22c4548b93b1426e' \
  -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/orchestrations:export?envName=dev&profileNames=dev,test&renderType=MANIFEST&suitableResourceType=KUBERNETES&sha=d23ccbd926c31e3cxxxxxxx3f22c4548b93b1426e' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	object	导出应用编排响应。	{ "demo-deployment.yaml": "---\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: k8s-111-dev\n labels:\n run: k8s-111-dev\n namespace: default\nspec:\n replicas: 1\n selector:\n matchLabels:\n run: k8s-111-dev\n template:\n metadata:\n labels:\n run: k8s-111-dev\n spec:\n containers:\n - name: main\n image: NULL\n ports:\n - containerPort: 8080\n resources:\n limits:\n cpu: 1\n memory: 1024Mi\n requests:\n cpu: 0.01\n memory: 32Mi", "demo-service.yaml": "---\napiVersion: v1\nkind: Service\nmetadata:\n name: k8s-111-dev\n namespace: default\nspec:\n selector:\n run: k8s-111-dev\n ports:\n - protocol: TCP\n port: 80\n targetPort: 8080" }

返回示例

{
    "demo-deployment.yaml": "---\\napiVersion: apps/v1\\nkind: Deployment\\nmetadata:\\n  name: k8s-111-dev\\n  labels:\\n    run: k8s-111-dev\\n  namespace: default\\nspec:\\n  replicas: 1\\n  selector:\\n    matchLabels:\\n      run: k8s-111-dev\\n  template:\\n    metadata:\\n      labels:\\n        run: k8s-111-dev\\n    spec:\\n      containers:\\n        - name: main\\n          image: NULL\\n          ports:\\n            - containerPort: 8080\\n          resources:\\n            limits:\\n              cpu: 1\\n              memory: 1024Mi\\n            requests:\\n              cpu: 0.01\\n              memory: 32Mi",
    "demo-service.yaml": "---\\napiVersion: v1\\nkind: Service\\nmetadata:\\n  name: k8s-111-dev\\n  namespace: default\\nspec:\\n  selector:\\n    run: k8s-111-dev\\n  ports:\\n    - protocol: TCP\\n      port: 80\\n      targetPort: 8080"
}

错误码

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