更新时间:2025-04-25 GMT+08:00
分享

创建访问端点

功能介绍

创建访问端点。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户资源空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

endpoint名称,租户下唯一,由字母、数字、点、下划线和中划线组成,必须以字母或数字开头

vpc_id

String

访问端点所在的VPC的ID

subnet_id

String

访问端点所在的子网的ID

description

String

描述

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表5 响应Body参数

参数

参数类型

描述

id

String

访问端点ID

name

String

用户指定的访问端点名称

vpc_id

String

访问端点所在的VPC的ID

subnet_id

String

访问端点所在的子网的ID

domain

String

访问域名

description

String

描述

status

String

访问端点状态

error_info

ErrorInfo object

错误信息

type

String

访问端点类型

scalable

Boolean

是否可更新

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

endpoints

Array of EndpointConnection objects

访问端点终端节点列表

表6 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

error_detail

String

错误详情

error_msg

String

错误信息

表7 EndpointConnection

参数

参数类型

描述

endpoint_service_id

String

访问端点的服务ID

endpoint_service_name

String

访问端点的服务名称

marker_id

String

访问端点的终端节点的报文ID

id

String

访问端点的终端节点ID

ip

String

访问端点的终端节点IP

created_time

String

访问端点的终端节点创建时间

请求示例

创建访问端点

GET https://{eg_endpoint}/v1/{project_id}/endpoints

{
  "name" : "endpoint",
  "vpc_id" : "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
  "subnet_id" : "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
  "description" : "string"
}

响应示例

状态码:200

成功

{
  "id" : "23709d68-54d5-423b-a6be-03302e893152",
  "name" : "endpoint",
  "vpc_id" : "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
  "subnet_id" : "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
  "domain" : "events.cn-north-4.myhuaweicloud.com",
  "description" : "访问端点",
  "status" : "CREATED",
  "error_info" : { },
  "type" : "PRIVATE",
  "scalable" : false,
  "created_time" : "2021-12-09 09:00:00",
  "updated_time" : "2021-12-09 09:00:00",
  "endpoints" : [ { } ]
}

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档