GetAppOrchestration - 查找应用编排详情

服务接入点与授权信息

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

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

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

请求语法

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

请求头

请求参数

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/appstack/organizations/anyOrganizationId/apps/my-web-service/orchestrations/my-web-service@KUBERNETES?tagName=demotag&sha=d23ccbd926c31e3ca0b153f22c4548b93b1426e' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

返回示例

{
    "app": {
        "creatorId": "user-xxxx",
        "description": "app-description-xxx",
        "favoured": false,
        "gmtCreate": "2024-09-01 00:00:00",
        "labelList": [
            {
                "displayName": "测试标签键",
                "displayValue": "测试标签值",
                "extraMap": {
                },
                "name": "demo-label",
                "namespace": "default",
                "value": "demo-label-value"
            }
        ],
        "name": "app-name-xxx",
        "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": "user-xxx",
        "commitTime": "2024-09-01 00:00:00",
        "message": "revision-message-xxx",
        "sha": "revision-sha-xxx"
    },
    "sn": "app-builtin-orchestration-1",
    "storageType": "BUILTIN",
    "suitableResourceTypes": [
        
    ],
    "syncSourceTemplate": {
        "appTemplateName": "app-template-name",
        "orchestrationSha": "app-template-version-sha"
    },
    "type": "AppBuiltInOrchestration"
}

{
    "app": {
        "creatorId": "user-xxxx",
        "description": "app-description-xxx",
        "favoured": false,
        "gmtCreate": "2024-09-01 00:00:00",
        "labelList": [
            {
                "displayName": "测试标签键",
                "displayValue": "测试标签值",
                "extraMap": {
                },
                "name": "demo-label",
                "namespace": "default",
                "value": "demo-label-value"
            }
        ],
        "name": "app-name-xxx",
        "type": "APP"
    },
    "creatorId": "app-builtin-creator-id",
    "datasource": {
        "auth": {
            "connectionId": "connection-id",
            "connectionType": "FLOW"
        },
        "extra": {
            "defaultBranch": "master",
            "projectId": "project-id-xxx",
            "rootDir": "/"
        },
        "type": "CODEUP",
        "url": "http://xxxxxxxxx"
    },
    "description": "app-builtin-orchestration-description",
    "format": "EXTERNAL",
    "gmtCreate": "2024-09-01 00:00:00",
    "gmtModified": "2024-09-01 00:00:00",
    "modifierId": "app-builtin-modifier-id",
    "name": "app-builtin-orchestration-name",
    "revision": {
        "author": "user-xxx",
        "commitTime": "2024-09-01 00:00:00",
        "message": "revision-message-xxx",
        "sha": "revision-sha-xxx"
    },
    "sn": "app-builtin-orchestration-1",
    "storageType": "EXTERNAL",
    "suitableResourceTypes": [
        
    ],
    "type": "AppBuiltInOrchestration"
}

{
    "app": {
        "creatorId": "user-xxxx",
        "description": "app-description-xxx",
        "favoured": false,
        "gmtCreate": "2024-09-01 00:00:00",
        "labelList": [
            {
                "displayName": "测试标签键",
                "displayValue": "测试标签值",
                "extraMap": {
                },
                "name": "demo-label",
                "namespace": "default",
                "value": "demo-label-value"
            }
        ],
        "name": "app-name-xxx",
        "type": "APP"
    },
    "creatorId": "app-builtin-creator-id",
    "datasource": {
        "auth": {
            "connectionId": "connection-id",
            "connectionType": "FLOW"
        },
        "extra": {
            "defaultBranch": "master",
            "projectId": "project-id-xxx",
            "rootDir": "/"
        },
        "type": "CUSTOM_GITLAB",
        "url": "http://xxxxxxxxx"
    },
    "description": "app-builtin-orchestration-description",
    "format": "EXTERNAL",
    "gmtCreate": "2024-09-01 00:00:00",
    "gmtModified": "2024-09-01 00:00:00",
    "modifierId": "app-builtin-modifier-id",
    "name": "app-builtin-orchestration-name",
    "revision": {
        "author": "user-xxx",
        "commitTime": "2024-09-01 00:00:00",
        "message": "revision-message-xxx",
        "sha": "revision-sha-xxx"
    },
    "sn": "app-builtin-orchestration-1",
    "storageType": "EXTERNAL",
    "suitableResourceTypes": [
        
    ],
    "type": "AppBuiltInOrchestration"
}

错误码

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