文档首页/ 智能边缘平台 IEF/ API参考/ API/ 端点管理/ 创建端点 - CreateEndpoint
更新时间：2025-11-18 GMT+08:00
查看PDF
分享

创建端点 - CreateEndpoint

功能介绍

该API用于创建一个端点。

URI

POST /v2/{project_id}/routemgr/endpoints

表1 Path参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

类型

描述

Content-Type

是

String

消息体的类型（格式）

推荐您使用默认值application/json。

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

ief-instance-id

否

String

企业版实例ID，专业版实例为空值
表3 请求Body参数

参数

是否必选

参数类型

描述

endpoint

否

Endpoint object

端点详情
表4 Endpoint

参数

是否必选

参数类型

描述

description

否

String

端点描述，最大长度255，不允许^~#$%&*<>()[]{}'"\

ief_instance_id

否

String

企业版实例ID，如果为空则表示是专业版实例。

name

是

String

端点名称，只允许中文字符、英文字符、数字、下划线、中划线，最大长度64

同一个账号中创建的端点名唯一

properties

是

Map<String,Object>

端点的属性，端点需要对外展示的属性，示例：

  • dis： 
    {"domain_id":"user's domain id"}
  • servicebus： 
    {"service_port":8080}
  • apigw： 
    {"domain_id":"user's domain id"}

type

是

String

端点类型

枚举值：

  • dis
  • servicebus
  • apigw

响应参数

状态码为 201 时：

表5 响应Body参数

参数

参数类型

描述

endpoint

EndpointResponse object

端点详情
表6 EndpointResponse

参数

参数类型

描述

created_at

String

创建时间

description

String

端点描述，最大长度255，不允许^~#$%&*<>()[]{}'"\

id

String

端点ID

ief_instance_id

String

企业版实例ID，如果为空则表示是专业版实例。

is_shared

Boolean

是否共享

name

String

端点名称，只允许中文字符、英文字符、数字、下划线、中划线，最大长度64

同一个账号中创建的端点名唯一

project_id

String

项目ID

properties

Map<String,Object>

端点的属性，端点需要对外展示的属性，示例：

  • dis： 
    {"domain_id":"user's domain id"}
  • servicebus： 
    {"service_port":8080}
  • apigw： 
    {"domain_id":"user's domain id"}

type

String

端点类型

枚举值：

  • dis
  • servicebus
  • apigw

updated_at

String

更新时间

状态码为 400 时：

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_message

String

错误信息

状态码为 401 时：

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_message

String

错误信息

状态码为 500 时：

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_message

String

错误信息

请求示例

{
  "endpoint" : {
    "name" : "dis_example",
    "type" : "dis",
    "properties" : {
      "domain_id" : "8fd3691d01f44badab03e28d81abd4ff"
    }
  }
}

响应示例

无

状态码

状态码

描述

201

创建成功

400

错误响应

401

错误响应

500

错误响应

错误码

请参见错误码。

父主题： 端点管理