文档首页/流水线 CodeArts Pipeline/API参考/API/扩展点管理/创建服务扩展点 - CreateEndpoint
更新时间：2025-12-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建服务扩展点 - CreateEndpoint

功能介绍

创建服务扩展点

调用方法

请参见如何调用API。

URI

POST /v1/serviceconnection/endpoints

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

url

否

String

参数解释：

url路径。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

扩展点名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

project_uuid

否

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

region_name

否

String

参数解释：

区域名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

module_id

否

String

参数解释：

模块ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

authorization

否

EndpointAuthorizationBody object

参数解释：

权限信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

data

否

Object

参数解释：

扩展点数据结构体。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 EndpointAuthorizationBody

参数

是否必选

参数类型

描述

parameters

否

Object

参数解释：

鉴权参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

scheme

否

String

参数解释：

鉴权模式。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

参数解释：

错误信息，接口正常无报错时不返回error字段。

取值范围：

不涉及。

result

Object

参数解释：

返回结果。

取值范围：

不涉及。

status

String

参数解释：

状态值。

取值范围：

不涉及。

表4 ErrorInfo

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

不涉及。

message

String

参数解释：

错误信息。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

{
  "url" : "https://test.com",
  "name" : "test",
  "project_uuid" : "6cb920b7932948a3ade7ec1d712494eb",
  "region_name" : "regionName",
  "authorization" : {
    "parameters" : {
      "username" : "username",
      "state" : "redirectURI",
      "password" : "password"
    },
    "scheme" : "endpoint-auth-scheme-basic"
  },
  "data" : {
    "key1" : "value1",
    "key2" : "value2"
  },
  "module_id" : "devcloud2018.codesource-authenticate-generic.oauth02"
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "error" : null,
  "result" : {
    "uuid" : "c6bbed0feaea4c6aa24da7fd86b886e8",
    "url" : "https://test.com",
    "name" : "test",
    "projectUuid" : "6cb920b7932948a3ade7ec1d712494eb",
    "regionName" : "regionName",
    "authorization" : {
      "parameters" : {
        "username" : "username",
        "state" : "redirectURI",
        "password" : "password"
      },
      "scheme" : "endpoint-auth-scheme-basic"
    },
    "data" : {
      "key1" : "value1",
      "key2" : "value2"
    },
    "moduleId" : "devcloud2018.codesource-authenticate-generic.oauth02",
    "created_by" : {
      "username" : "user_01",
      "user_id" : "user_id"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题：扩展点管理