接口功能介绍
创建终端节点服务
接口约束
无
URI
POST /v4/vpce/create-endpoint-service
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 资源池ID | 81f7728662dd11ec810800155d307d5b |
| name | String | 是 | 终端节点服务名称，只能由数字，字母，-组成不能以数字和-开头，最大长度28 | szyy2 |
| vpcID | String | 是 | 所属的专有网络id | vpc-srsiebllhc |
| type | String | 否 | 接口还是反向，interface:接口，reverse:反向,默认接口 | interface |
| description | String | 否 | 描述,支持拉丁字母、中文、数字, 特殊字符： |
test |
| instanceType | String | 是 | 服务后端实例类型，vm:虚机类型,bm:物理机,vip:vip类型,lb:负载均衡类型 | lb |
| instanceID | String | 是 | 服务后端实例id | lb-tfa20qb11w |
| subnetID | String | 是 | 服务后端子网id | subnet-7owr4do29a |
| autoConnection | Bool | 是 | 是否自动连接，true 表示自动链接，false 表示非自动链接 | false |
| oaType | String | 否 | oa 类型，支持: close/tcp_option/ proxy_protocol | close |
| dnsName | String | 否 | dns 名字，仅支持有权限的用户修改 | a.b.c |
| rules | Array of Objects | 否 | 节点服务规则 | 见下表 |
表 rules
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| protocol | String | 是 | 协议，TCP:TCP协议,UDP:UDP协议 | TCP |
| serverPort | Integer | 是 | 服务端口(用于创建backend传入)(1-65535) | 1 |
| endpointPort | Integer | 是 | 节点端口(用于创建rule传入)(1-65535) | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息，英文 | success |
| descritption | String | statusCode为900时的错误信息，中文 | |
| errCode | String | 错误明细 | SUCCESS |
| returnObj | Object | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| endpointService | Object | 创建的终端节点服务信息 | 见下表 |
表 endpointService
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| endpointServiceID | String | 创建的终端节点 ID | endpser-p26klspn9b |
请求示例
POST /v4/vpce/create-endpoint-service
请求体Body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"name":"szyy2",
"description":"aaa",
"vpcID":"vpc-srsiebllhc",
"type":"interface",
"instanceType":"lb",
"instanceID":"lb-tfa20qb11w",
"subnetID": "subnet-7owr4do29a",
"autoConnection":true,
"rules":[{
"protocol":"TCP",
"serverPort":100,
"endpointPort":100
}]
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"endpointService": {
"endpointServiceID": "endpser-p26klspn9b"
}
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
