調用CreateCustomRoutingEndpoints接口創建自定義路由類型監聽的終端節點。
接口說明
配置自定義路由類型監聽后，全球加速實例能夠根據配置的監聽端口范圍、目標終端節點組協議和端口范圍，以及終端節點（交換機 vSwitch）的 IP 地址信息，生成端口映射表，從而確定性地將流量路由到交換機中特定 IP 地址和端口。
本接口用于創建自定義路由類型監聽的終端節點。在調用本接口時，請注意以下事項：
- CreateCustomRoutingEndpoints 接口屬于異步接口，即系統會先返回一個請求 ID，但終端節點并未創建完成，系統后臺的創建任務仍在進行。您可以通過調用 DescribeCustomRoutingEndpointGroup 接口查詢終端節點組的狀態，來確認終端節點是否創建完成：
- 當終端節點組處于 updating 狀態時，表示終端節點正在創建中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
- 當終端節點組處于 active 狀態時，表示終端節點創建完成。
- CreateCustomRoutingEndpoints 接口不支持在同一個全球加速實例內并發創建自定義路由監聽的終端節點。
前提條件
創建自定義路由類型監聽的終端節點前，請確保您已完成以下操作：
- 已創建標準型全球加速實例。具體操作，請參見 CreateAccelerator 。
- 已將帶寬包與標準型全球加速實例綁定。具體操作，請參見 BandwidthPackageAddAccelerator 。
- 已部署了相關應用，作為全球加速的后端服務接收轉發的請求。自定義路由類型監聽的后端服務類型僅支持交換機（vSwitch）。
- 已申請了自定義路由類型監聽使用權限并創建了自定義路由類型監聽。監聽支持選擇自定義路由類型的功能邀測中，如需使用，請聯系阿里云客戶經理。創建自定義路由類型監聽，請參見 CreateListener 。
- 已創建自定義路由類型監聽的終端節點組。具體操作，請參見 CreateCustomRoutingEndpointGroups 。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ga:CreateCustomRoutingEndpoints | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 全球加速實例所在的地域 ID，僅取值cn-hangzhou。 | cn-hangzhou |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
| EndpointGroupId | string | 是 | 待創建終端節點的終端節點組 ID。 | epg-bp1bpn0kn908w4nb**** |
| EndpointConfigurations | array<object> | 是 | 終端節點信息。 您最多可輸入 20 個終端節點信息。 | |
| object | 是 | 終端節點信息。 您最多可輸入 20 個終端節點信息。 | ||
| Type | string | 否 | 終端節點后端服務類型。取值： PrivateSubNet（默認值）：私網 CIDR。 | PrivateSubNet |
| Endpoint | string | 否 | 終端節點交換機（vSwitch）實例 ID。 | vsw-test01 |
| TrafficToEndpointPolicy | string | 否 | 后端服務流量通行策略，取值：
| DenyAll |
| PolicyConfigurations | array<object> | 否 | 流量通行目標配置。 每個終端節點下，最多可輸入 20 個通行目標。 | |
| object | 是 | 流量通行目標配置。 每個終端節點下，最多可輸入 20 個通行目標。 | ||
| Address | string | 是 | 指定可以接受訪問流量的通行目標 IP 地址。 僅當 TrafficToEndpointPolicy 取值為 AllowCustom 時，該項生效。 每個終端節點下，最多可輸入 20 個通行目標 IP 地址。 | 10.0.XX.XX |
| PortRanges | array<object> | 否 | 指定可以接受訪問流量的通行目標端口范圍。該端口范圍必須屬于終端節點組后端服務端口范圍。 輸入為空時，表示支持該通行目標的所有端口。 僅當 TrafficToEndpointPolicy 取值為 AllowCustom 時，該項生效。 每個終端節點下，最多可輸入 20 個通行目標的端口范圍，每個通行目標最多可輸入 20 個端口范圍。 | |
| object | 否 | 指定可以接受訪問流量的通行目標端口范圍。該端口范圍必須屬于終端節點組后端服務端口范圍。 輸入為空時，表示支持該通行目標的所有端口。 僅當 TrafficToEndpointPolicy 取值為 AllowCustom 時，該項生效。 每個終端節點下，最多可輸入 20 個通行目標的端口范圍，每個通行目標最多可輸入 20 個端口范圍。 | ||
| FromPort | integer | 否 | 指定可以接受訪問流量的通行目標的起始端口。該端口取值必須屬于終端節點組后端服務端口范圍。 僅當 TrafficToEndpointPolicy 取值為 AllowCustom 時，該項生效。 每個終端節點下，最多可輸入 20 個通行目標的端口范圍，每個通行目標最多可輸入 20 個起始端口。 | 80 |
| ToPort | integer | 否 | 指定可以接受訪問流量的通行目標的結束端口。該端口取值必須屬于終端節點組后端服務端口范圍。 僅當 TrafficToEndpointPolicy 取值為 AllowCustom 時，該項生效。 每個終端節點下，最多可輸入 20 個通行目標的端口范圍，每個通行目標最多可輸入 20 個結束端口。 | 80 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"EndpointIds": [
"epg-bp1dmlohjjz4kqaun****"
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | NotExist.EndPointGroup | endpoint group %s is not exist | 終端節點組%s不存在 |
| 400 | StateError.Accelerator | accelerator state %s is illegal | 加速實例狀態%s非法 |
| 400 | StateError.EndPointGroup | endpoint group state %s is illegal | 終端節點組狀態非法 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-23 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-04-20 | API 內部配置變更，不影響調用 | 查看變更詳情 |