創建終端節點
更新時間 2025-05-12 17:00:52
最近更新時間: 2025-05-12 17:00:52
分享文章
接口功能介紹
創建終端節點
接口約束
無
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 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
