中文英文
 编辑文档
 反馈问题
 社区讨论

本页导航

服务

提示

本文所介绍的 OpenAPI 适用于 K8s YAML 服务。

# 获取服务列表

# 测试服务

请求

GET /openapi/service/yaml/services?projectKey=<项目标识>
1

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

返回说明

参数名类型描述
service_namestring服务名称
typestring服务类型，固定值 k8s
containers[]Container服务组件列表

Container 参数说明

参数名类型描述
namestring服务组件名称
imagestring服务组件的镜像信息
image_namestring服务组件的镜像名称

返回示例

点击查看
{
    "service": [
        {
            "service_name": "service-1",
            "type": "k8s",
            "containers": [
                {
                    "name": "myapp-1",
                    "image": "koderover.tencentcloudcr.com/koderover-demo/myapp-1:v0.1__linux_amd64",
                    "image_name": "myapp-1"
                }
            ]
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 生产服务

请求

GET /openapi/service/yaml/production/services?projectKey=<项目标识>
1

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

返回说明

参数名类型描述
service_namestring服务名称
typestring服务类型，固定值 k8s
containers[]Container服务组件列表

Container

参数名类型描述
namestring服务组件名称
imagestring服务组件的镜像信息
image_namestring服务组件的镜像名称

返回示例

点击查看
[
        {
            "service_name": "service-1",
            "type": "k8s",
            "containers": [
                {
                    "name": "myapp-1",
                    "image": "koderover.tencentcloudcr.com/koderover-demo/myapp-1:v0.1__linux_amd64",
                    "image_name": "myapp-1"
                }
            ]
        }
]
1
2
3
4
5
6
7
8
9
10
11
12
13

# 获取服务详情

# 测试服务

请求

GET /openapi/service/yaml/:serviceName?projectKey=<项目标识>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

返回说明

参数名类型描述
service_namestring服务名称
created_bystring服务创建者
created_timeint服务创建时间
typestring服务类型，固定为 k8s
containers[]Container服务组件列表
service_variable_kvs[]KeyVal服务变量列表
yamlstring服务配置的 YAML 内容

Container 参数说明

参数名类型描述
namestring服务组件名称
imagestring服务组件的镜像信息
image_namestring服务组件的镜像名称

KeyVal 参数说明

参数名说明类型必填
key变量的键string是
value变量的值，若有嵌套值，使用 json 格式any是
type变量值的类型，有四种类型：bool、string、enum、yamlstring是
options变量可选值列表，当 type 为 enum 时该字段有意义[]string否
desc变量描述信息String否

返回示例

点击查看
{
    "service_name": "service2",
    "type": "k8s",
    "created_by": "admin",
    "created_time": 1689660993,
    "yaml": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: service2\n  labels: \n    app.kubernetes.io/name: ai-test-2\n    app.kubernetes.io/instance: service2\n    hello: test\nspec:\n  selector:\n    matchLabels:\n      app.kubernetes.io/name: ai-test-2\n      app.kubernetes.io/instance: service2\n  replicas: 1\n  template:\n    metadata: \n      labels:\n        app.kubernetes.io/name: ai-test-2\n        app.kubernetes.io/instance: service2\n        hello: {{.world}}\n    spec:\n      containers:\n        - name: service2\n          image: koderover.******.com/koderover-demo/service2:latest\n          imagePullPolicy: Always \n          command:\n            - /workspace/service2\n          ports:\n            - protocol: TCP\n              containerPort: {{.port}}\n          resources:\n            limits:\n              memory: {{.memoryLimit}}\n              cpu: {{.cpuLimit}}\n---\napiVersion: v1\nkind: Service\nmetadata:\n  name: service2\n  labels:\n    app.kubernetes.io/name: ai-test-2\n    app.kubernetes.io/instance: service2\nspec:\n  type: NodePort\n  ports:\n    - protocol: TCP\n      port: {{.port}}\n      targetPort: {{.port}}",
    "containers": [
        {
            "name": "service2",
            "image": "koderover.******.com/koderover-demo/service2:latest",
            "image_name": "service2"
        }
    ],
    "service_variable_kvs": [
        {
            "key": "cpuLimit",
            "value": "55m",
            "type": "string",
            "options": [],
            "desc": ""
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 生产服务

请求

GET /openapi/service/yaml/production/:serviceName?projectKey=<项目标识>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

返回说明

参数名类型描述
service_namestring服务名称
created_bystring服务创建者
created_timeint服务创建时间
typestring服务类型，固定为 k8s
containers[]Container服务组件列表
service_variable_kvs[]KeyVal服务变量列表
yamlstring服务配置的 YAML 内容

Container 参数说明

参数名类型描述
namestring服务组件名称
imagestring服务组件的镜像信息
image_namestring服务组件的镜像名称

KeyVal 参数说明

参数名说明类型必填
key变量的键string是
value变量的值，若有嵌套值，使用 json 格式any是
type变量值的类型，有四种类型：bool、string、enum、yamlstring是
options变量可选值列表，当 type 为 enum 时该字段有意义[]string否
desc变量描述信息String否

返回示例

点击查看
{
    "service_name": "service2",
    "type": "k8s",
    "created_by": "admin",
    "created_time": 1689660993,
    "yaml": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: service2\n  labels: \n    app.kubernetes.io/name: ai-test-2\n    app.kubernetes.io/instance: service2\n    hello: test\nspec:\n  selector:\n    matchLabels:\n      app.kubernetes.io/name: ai-test-2\n      app.kubernetes.io/instance: service2\n  replicas: 1\n  template:\n    metadata: \n      labels:\n        app.kubernetes.io/name: ai-test-2\n        app.kubernetes.io/instance: service2\n        hello: {{.world}}\n    spec:\n      containers:\n        - name: service2\n          image: koderover.******.com/koderover-demo/service2:latest\n          imagePullPolicy: Always \n          command:\n            - /workspace/service2\n          ports:\n            - protocol: TCP\n              containerPort: {{.port}}\n          resources:\n            limits:\n              memory: {{.memoryLimit}}\n              cpu: {{.cpuLimit}}\n---\napiVersion: v1\nkind: Service\nmetadata:\n  name: service2\n  labels:\n    app.kubernetes.io/name: ai-test-2\n    app.kubernetes.io/instance: service2\nspec:\n  type: NodePort\n  ports:\n    - protocol: TCP\n      port: {{.port}}\n      targetPort: {{.port}}",
    "containers": [
        {
            "name": "service2",
            "image": "koderover.******.com/koderover-demo/service2:latest",
            "image_name": "service2"
        }
    ],
    "service_variable_kvs": [
        {
            "key": "cpuLimit",
            "value": "55m",
            "type": "string",
            "options": [],
            "desc": ""
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 获取服务标签

请求

GET /openapi/service/yaml/:serviceName/labels?projectKey=<项目标识>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query参数说明

参数名类型描述必填
projectKeystring项目标识是

返回实例

正确时返回

[
  {
    "key": "key",
    "value": "value"
  },
  ...
]
1
2
3
4
5
6
7

错误时返回

{
  "code": 500,
  "description": "...",
  "message": "Internal Error"
}
1
2
3
4
5

# 使用模板新建服务

# 测试服务

请求

POST /openapi/service/template/load/yaml
1

Body 参数说明

参数名说明类型必填
service_name服务名称string是
project_key项目标识string是
template_nameK8s Yaml 模板名称string是
auto_sync自动同步开关bool否
variable_yaml模板中的变量信息[]KeyVal否

KeyVal 参数说明

参数名说明类型必填
key变量的键值string是
value变量的值，若有嵌套值，使用 json 格式any是

Body 参数示例

使用模板 microservice-template 为项目 demo 新建服务 service1：

点击查看
{
    "service_name": "service1",
    "project_key":"demo",
    "template_name": "microservice-template",
    "auto_sync": true,
    "variable_yaml": [
        {
            "key": "cpuLimit",
            "value": "100m"
        },
        {
            "key": "memoryLimit",
            "value": "100Mi"
        },
        {
            "key": "port",
            "value": "20221"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

返回

{
  "message": "success"
}
1
2
3

# 生产服务

请求

POST /openapi/service/template/production/load/yaml
1

Body 参数说明

参数名说明类型必填
service_name服务名称string是
yaml服务的 YAML 内容string是
project_key项目标识string是
template_nameK8s Yaml 模板名称string是
auto_sync自动同步开关bool否
variable_yaml模板中的变量信息[]KeyVal否

KeyVal 参数说明

参数名说明类型必填
key变量的键值string是
value变量的值，若有嵌套值，使用 json 格式any是

Body 参数示例

使用模板 base-template 为项目 demo 新建服务 service1：

点击查看
{
    "service_name": "service1",
    "production":true,
    "project_key":"demo",
    "template_name":"base-template",
    "auto_sync":true,
    "variable_yaml":[
        {
            "key":"cpuLimit",
            "value":"15m"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13

返回

{
  "message": "success"
}
1
2
3

# 手动输入新建服务

# 测试服务

请求

POST /openapi/service/yaml/raw?projectKey=<项目标识>
1

Body 参数说明

参数名说明类型必填
service_name服务名称string是
yaml服务的 YAML 内容string是
variable_yamlyaml中的变量信息[]KeyVal否

KeyVal 参数说明

参数名说明类型必填
key变量的键string是
value变量的值，若有嵌套值，使用 json 格式any是
type变量值的类型，有四种类型：bool、string、enum、yamlstring是
options变量可选值列表，当 type 为 enum 时该字段有意义[]string否
desc变量描述信息String否

Body 参数示例

点击查看
{
    "service_name":"service-3",
    "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.******.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: {{.cpu}}\n            memory: 122Mi\n",
    "variable_yaml":[
        {
            "key":"cpu",
            "value":"12m",
            "desc":"cpu值",
            "type":"string"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12

返回

{
  "message": "success"
}
1
2
3

# 生产服务

请求

POST /openapi/service/yaml/production/raw?projectKey=<项目标识>
1

Body 参数说明

参数名说明类型必填
service_name服务名称string是
yaml服务的 YAML 内容string是
variable_yamlyaml中的变量信息[]KeyVal否

KeyVal 参数说明

参数名说明类型必填
key变量的键string是
value变量的值，若有嵌套值，使用 json 格式any是
type变量值的类型，有四种类型：bool、string、enum、yamlstring是
options变量可选值列表，当 type 为 enum 时该字段有意义[]string否
desc变量描述信息String否

Body 参数示例

点击查看
{
    "service_name":"service-3",
    "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.******.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: {{.cpu}}\n            memory: 122Mi\n",
    "variable_yaml":[
        {
            "key":"cpu",
            "value":"12m",
            "desc":"cpu值",
            "type":"string"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12

返回

{
  "message": "success"
}
1
2
3

# 更新服务配置

# 测试服务

# 请求

PUT /openapi/service/yaml/:serviceName?projectKey=<project_name>
1

# 路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

# Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

# Body 参数说明

参数名说明类型必填
type服务类型，指定为 k8sstring是
yaml服务配置的 YAML 内容string是

Body 参数示例

点击查看
{
    "type":"k8s",
    "yaml":"apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: service1\n  labels: \n    app.kubernetes.io/name: demo\n    app.kubernetes.io/instance: service1\nspec:\n  selector:\n    matchLabels:\n      app.kubernetes.io/name: demo\n      app.kubernetes.io/instance: service1\n  replicas: 1\n  template:\n    metadata: \n      labels:\n        app.kubernetes.io/name: demo\n        app.kubernetes.io/instance: service1\n    spec:\n      containers:\n        - name: service1\n          image: koderover.******.com/koderover-demo/service1:latest\n          imagePullPolicy: Always \n          command:\n            - /workspace/service1\n          ports:\n            - protocol: TCP\n              containerPort: {{.port}}\n          resources:\n            limits:\n              memory: {{.memoryLimit}}\n              cpu: {{.cpuLimit}}\n---\napiVersion: v1\nkind: Service\nmetadata:\n  name: service1\n  labels:\n    app.kubernetes.io/name: yaml-poc\n    app.kubernetes.io/instance: service1\nspec:\n  type: NodePort\n  ports:\n    - protocol: TCP\n      port: {{.port}}\n      targetPort: {{.port}}\n",
}
1
2
3
4

# 返回

{
  "message": "success"
}
1
2
3

# 生产服务

请求

PUT /openapi/service/yaml/production/:serviceName?projectKey=<project_name>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

Body 参数说明

参数名说明类型必填
type服务类型，指定为 k8sstring是
yaml服务配置的 YAML 内容string是

Body 参数示例

点击查看
{
    "type":"k8s",
    "yaml":"apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: service1\n  labels: \n    app.kubernetes.io/name: demo\n    app.kubernetes.io/instance: service1\nspec:\n  selector:\n    matchLabels:\n      app.kubernetes.io/name: demo\n      app.kubernetes.io/instance: service1\n  replicas: 1\n  template:\n    metadata: \n      labels:\n        app.kubernetes.io/name: demo\n        app.kubernetes.io/instance: service1\n    spec:\n      containers:\n        - name: service1\n          image: koderover.******.com/koderover-demo/service1:latest\n          imagePullPolicy: Always \n          command:\n            - /workspace/service1\n          ports:\n            - protocol: TCP\n              containerPort: {{.port}}\n          resources:\n            limits:\n              memory: {{.memoryLimit}}\n              cpu: {{.cpuLimit}}\n---\napiVersion: v1\nkind: Service\nmetadata:\n  name: service1\n  labels:\n    app.kubernetes.io/name: yaml-poc\n    app.kubernetes.io/instance: service1\nspec:\n  type: NodePort\n  ports:\n    - protocol: TCP\n      port: {{.port}}\n      targetPort: {{.port}}\n",
}
1
2
3
4

返回

{
  "message": "success"
}
1
2
3

# 更新服务变量

# 测试服务

请求

PUT /openapi/service/yaml/:serviceName/variable?projectKey=<projectKey>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

Body 参数说明

参数名说明类型必填
service_variable_kvs服务变量列表[]KeyVal是

KeyVal 参数说明

参数名说明类型必填
key变量的键string是
value变量的值，若有嵌套值，使用 json 格式any是
type变量值的类型，有四种类型：bool、string、enum、yamlstring是
options变量可选值列表，当 type 为 enum 时该字段有意义[]string否
desc变量描述信息String否

Body 参数示例

点击查看
{
    "service_variable_kvs": [
        {
            "key":"cpu",
            "value":"12m",
            "type":"string",
          	"options":[],
          	"desc":""
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11

返回

{
  "message": "success"
}
1
2
3

# 生产服务

请求

PUT /openapi/service/yaml/production/:serviceName/variable?projectKey=<projectKey>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

Body 参数说明

参数名说明类型必填
service_variable_kvs服务变量列表[]KeyVal是

KeyVal 参数说明

参数名说明类型必填
key变量的键string是
value变量的值，若有嵌套值，使用 json 格式any是
type变量值的类型，有四种类型：bool、string、enum、yamlstring是
options变量可选值列表，当 type 为 enum 时该字段有意义[]string否
desc变量描述信息String否

Body 参数示例

点击查看
{
    "service_variable_kvs": [
        {
            "key":"cpu",
            "value":"12m",
            "type":"string",
          	"options":[],
          	"desc":""
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11

返回

{
  "message": "success"
}
1
2
3

# 删除服务

# 测试服务

# 请求

DELETE /openapi/service/yaml/<服务名称>?projectKey=<项目标识>
1

# 返回

{
  "message": "success"
}
1
2
3

# 生产服务

请求

DELETE /openapi/service/yaml/production/:serviceName?projectKey=<项目标识>
1

路径参数说明

参数名类型描述必填
serviceNamestring服务名称是

Query 参数说明

参数名类型描述必填
projectKeystring项目标识是

返回

{
  "message": "success"
}
1
2
3

← 构建→

资源
教程
论坛
博客
公司
关于
客户故事
加入我们
联系我们
微信扫一扫
hello@koderover.com

© 2026 筑栈（上海）信息技术有限公司 沪 ICP 备 19000177 号 - 1