项目

创建项目

创建空项目

将会创建一个空的项目，不包含任何服务资源、环境资源。

请求

POST /openapi/projects/project

body 参数说明

返回

{
  "message": "success"
}

创建 YAML 项目并初始化

适用于 Kubernetes YAML 类型项目。

请求

POST /openapi/projects/project/init/yaml

body 参数说明

Service 参数说明

Env 参数说明

KeyVal 参数说明

body 参数示例

以创建 demo 项目，并初始化新建服务 myapp-1 和环境 dev 为例：

{
    "project_name": "demo",
    "project_key": "demo",
    "project_type": "yaml",
    "is_public": true,
    "description": "demo 项目",
    "service_list": [
        {
            "source": "yaml",
            "service_name": "myapp-1",
            "yaml": "apiVersion: v1\nkind: Service\nmetadata:\n  name: a\n  labels:\n    app: a\nspec:\n  ports:\n  - name: http\n    port: 80\n    targetPort: 8080\n  selector:\n    app: a\n\n---\n\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: a\n  labels:\n    app: a\nspec:\n  selector:\n    matchLabels:\n      app: a\n  replicas: 1\n  template:\n    metadata:\n      labels:\n        app: a\n    spec:\n      containers:\n      - name: myapp-1\n        image: koderover.tencentcloudcr.com/koderover-demo/myapp-1:v0.1__linux_amd64\n        imagePullPolicy: Always\n        command: [\"/myapp-1\"]\n        args: [\"--downstream-addr\", \"$(DOWNSTREAM_ADDR)\", \"--headers\", \"$(HEADERS)\"]\n        env:\n          - name: DOWNSTREAM_ADDR\n            value: \"b\"\n          - name: HEADERS\n            value: \"x-request-id\"\n        ports:\n        - containerPort: 8080\n        resources:\n          limits:\n            cpu: 100m\n            memory: 100Mi\n"
        }
    ],
    "env_list": [
        {
            "env_key": "dev",
            "cluster_name": "dev",
            "namespace": "demo-env-dev"
        }
    ]
}

返回

{
  "message": "success"
}

创建 Helm 项目并初始化

请求

POST /openapi/projects/project/init/helm

body 参数说明

Service 参数说明

Env 参数说明

KeyVal 参数说明

body 参数示例

{
    "project_name":"helm项目测试2",
    "project_key":"test-helm-2",
    "is_public":true,
    "description":"测试",
    "service_list":[
        {
            "source":"template",
            "service_name":"service33",
            "template_name":"minmin-helm-template",
            "variable_yaml":[{"key":"port","value":"7777"}],
            "values_yaml":"",
            "auto_sync":true
        }
    ],
    "env_list":[
        {
            "env_key":"dev1",
            "cluster_name":"local-20220823144517",
            "namespace":"test-helm-env-dev"
        }
    ]
}

返回

{
  "message": "success"
}

获取项目列表

请求

GET /openapi/projects/project?pageSize=<当前页显示数量>&pageNum=<当前页数>

Query 参数说明

返回说明

Project 参数说明

返回示例

{
    "total": 14,
    "projects": [
        {
            "project_name": "lilian-test",
            "project_key": "lilian-test",
            "description": "",
            "deploy_type":"k8s"
        },
        {
            "project_name": "发布中心",
            "project_key": "release-center",
            "description": "migrate from deploy center",
            "deploy_type":"k8s"
        }
    ]
}

获取指定项目详情

请求

GET /openapi/projects/project/detail?projectKey=<项目标识>

Query 参数说明

返回说明

返回示例

{
    "project_name": "lilian-test",
    "project_key": "lilian-test",
    "desc": "",
    "deploy_type": "k8s",
    "create_time": 1686134245,
    "created_by": "admin",
}

删除项目

请求

DELETE /openapi/projects/project?projectKey=<项目标识>&isDelete=<是否删除项目相关资源>

Query 参数说明

成功返回说明

{message: "success"}