接口功能介绍
创建终端节点
接口约束
无
URI
POST /v4/vpce/create-endpoint
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 资源池ID | 81f7728662dd11ec810800155d307d5b |
| cycleType | String | 是 | 收费类型：只能填写 on_demand | on_demand |
| endpointServiceID | String | 是 | 终端节点关联的终端节点服务 | |
| endpointName | String | 是 | 终端节点名称，只能由数字，字母，-组成不能以数字和-开头，最大长度28 | |
| subnetID | String | 是 | 子网id | subnet-xxxx |
| vpcID | String | 是 | vpc id | vpc-xxxx |
| IP | String | 否 | vpc address | 192.168.1.1 |
| whitelistFlag | int | 是 | 白名单开关 1.开启 0.关闭，默认1 | 1 |
| whitelist | String of Array | 否 | 白名单 | ['1.1.1.1/24'] |
| description | String | 否 | 描述,支持拉丁字母、中文、数字, 特殊字符： |
this is a test |
| enableDns | Boolean | 否 | 是否开启dns，true:开启,false:关闭 | false |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息，英文 | success |
| descritption | String | statusCode为900时的错误信息，中文 | |
| errCode | String | 错误明细 | SUCCESS |
| returnObj | Object | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| masterOrderID | String | 订单id | 4b52382c6b0d11edb33e0242ac110002 |
| masterOrderNO | String | 订单编号 | |
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
| masterResourceStatus | String | 资源状态: started（启用） / renewed（续订） / refunded（退订） / destroyed（销毁） / failed（失败） / starting（正在启用） / changed（变配）/ expired（过期）/ unknown（未知） | started |
| masterResourceID | String | 资源id | |
| endpointID | String | 终端节点ID, 当 masterResourceStatus 不为 started 时，该取值可为 null | null |
请求示例
POST /v4/vpce/create-endpoint
请求体Body
{
"clientToken": "et",
"regionID": "81f7728662dd11ec810800155d307d5b",
"endpointName": "test",
"endpointServiceID": "826a37c3-0b9f-4e37-bad2-6c8fa0ae9ecd",
"vpcID": "cd94e957-893f-5257-927e-aefdfa22af49",
"whitelist": ["10.10.1.0/24"],
"subnetID": "b0192cd3-dade-535e-afc9-d46ce8d55278"
}
响应示例
{
"statusCode": 900,
"message": "order in progress",
"description": "订单处理中，可使用订单ID查询或使用原clientToken重试下单",
"errorCode": "endpoint.order.inProgress",
"returnObj": {
"masterOrderID": "4b52382c6b0d11edb33e0242ac110002",
"masterOrderNO": null,
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterResourceStatus": "unknown",
"masterResourceID": null,
"endpointID": null,
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
