創建終端節點服務
更新時間 2025-05-16 11:34:33
最近更新時間: 2025-05-16 11:34:33
分享文章
接口功能介紹
創建終端節點服務
接口約束
無
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 | 否 | 描述，支持字母、中文、數字，?特殊字符：!@#$%^&*()_-+= <>?:{},./;'[]·！@#￥%……&*（） —— -+={}《》？：“”【】、；‘'，。、，不能以 http: / https: 開頭，長度 0 - 128 | 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 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
