調(diào)用CreateEndpointGroup接口創(chuàng)建終端節(jié)點(diǎn)組。
接口說明
-
調(diào)用本接口為四層協(xié)議監(jiān)聽創(chuàng)建虛擬終端節(jié)點(diǎn)組時,請確保已創(chuàng)建默認(rèn)終端節(jié)點(diǎn)組。
-
CreateEndpointGroup 接口屬于異步接口,即系統(tǒng)會先返回一個終端節(jié)點(diǎn)組 ID,但終端節(jié)點(diǎn)組并未創(chuàng)建完成,系統(tǒng)后臺的創(chuàng)建任務(wù)仍在進(jìn)行。您可以調(diào)用 DescribeEndpointGroup 查詢終端節(jié)點(diǎn)組的狀態(tài):
-
當(dāng)終端節(jié)點(diǎn)組處于 init 狀態(tài)時,表示終端節(jié)點(diǎn)組正在創(chuàng)建中,在該狀態(tài)下,您只能執(zhí)行查詢操作,不能執(zhí)行其他操作。
-
當(dāng)終端節(jié)點(diǎn)組處于 active 狀態(tài)時,表示終端節(jié)點(diǎn)組創(chuàng)建完成。
-
-
CreateEndpointGroup 接口不支持在同一個全球加速實(shí)例內(nèi)并發(fā)創(chuàng)建終端節(jié)點(diǎn)組。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ga:CreateEndpointGroup | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速實(shí)例所在的地域 ID,僅取值cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值,確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標(biāo)識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
AcceleratorId | string | 是 | 全球加速實(shí)例 ID。 | ga-bp1odcab8tmno0hdq**** |
Name | string | 否 | 終端節(jié)點(diǎn)組的名稱。 名稱長度為 1~128 個字符,以大小寫字母或中文開頭,可包含數(shù)字、半角句號(.)下劃線(_)和短劃線(-)。 | group1 |
Description | string | 否 | 終端節(jié)點(diǎn)組描述信息。 描述長度最大 200 字符,不能以 | EndpointGroup |
EndpointGroupRegion | string | 是 | 終端節(jié)點(diǎn)組所屬的地域 ID。 | cn-hangzhou |
ListenerId | string | 是 | 監(jiān)聽實(shí)例 ID。 | lsr-bp1bpn0kn908w4nbw**** |
TrafficPercentage | integer | 否 | 監(jiān)聽實(shí)例有多個終端節(jié)點(diǎn)組時,配置到不同終端節(jié)點(diǎn)組的流量比例。 取值范圍:1~100。 | 20 |
HealthCheckIntervalSeconds | integer | 否 | 健康檢查的時間間隔,單位:秒。 | 3 |
HealthCheckPath | string | 否 | 健康檢查路徑。 | /healthcheck |
HealthCheckPort | integer | 否 | 健康檢查的端口。 | 20 |
HealthCheckProtocol | string | 否 | 健康檢查的協(xié)議。取值:
| tcp |
ThresholdCount | integer | 否 | 針對健康檢查狀態(tài)變化所需要的連續(xù)健康檢查次數(shù),即從成功到失敗的連續(xù)健康檢查失敗次數(shù)或從失敗到成功的連續(xù)健康檢查成功次數(shù)。 取值范圍:2~10。默認(rèn)值:3。 | 3 |
EndpointConfigurations | array<object> | 否 | 終端節(jié)點(diǎn)配置信息。 | |
object | 否 | 終端節(jié)點(diǎn)配置信息。 | ||
Type | string | 是 | 終端節(jié)點(diǎn)類型,取值:
說明
更多信息,請參見服務(wù)關(guān)聯(lián)角色。 | Ip |
EnableClientIPPreservation | boolean | 否 | 是否使用 TOA 方式開啟保持客戶端源 IP 功能,取值:
| false |
Weight | integer | 是 | 終端節(jié)點(diǎn)的權(quán)重。 取值范圍:0~255。 說明
如果某個終端節(jié)點(diǎn)的權(quán)重設(shè)置為 0,全球加速將終止向該終端節(jié)點(diǎn)分發(fā)流量,請您謹(jǐn)慎操作。
| 20 |
EnableProxyProtocol | boolean | 否 | 是否使用 ProxyProtocol 方式開啟保持客戶端源 IP 功能,取值:
| |
Endpoint | string | 是 | 根據(jù) Type(終端節(jié)點(diǎn)類型)輸入對應(yīng)的 IP、域名或?qū)嵗?ID。 | 120.1.XX.XX |
SubAddress | string | 否 | 彈性網(wǎng)卡的私網(wǎng) IP 地址。 說明
當(dāng)終端節(jié)點(diǎn)類型為 ENI 時,可以選擇配置該參數(shù),如果不配置默認(rèn)為 ENI 的主私網(wǎng) IP 地址。
| 172.168.X.X |
EndpointRequestProtocol | string | 否 | 后端服務(wù)協(xié)議。取值:
說明
| HTTP |
EndpointProtocolVersion | string | 否 | 后端服務(wù)協(xié)議版本。取值: HTTP1.1(默認(rèn)值):HTTP1.1 版本。 HTTP2:HTTP2 協(xié)議。 說明
僅當(dāng) EndpointRequestProtocol(后端服務(wù)協(xié)議)值為 HTTPS 時,支持配置終端節(jié)點(diǎn)后端服務(wù)協(xié)議版本。
| |
EndpointGroupType | string | 否 | 終端節(jié)點(diǎn)組類型。取值:
說明
為四層監(jiān)聽創(chuàng)建虛擬終端節(jié)點(diǎn)組時,請確保已創(chuàng)建默認(rèn)終端節(jié)點(diǎn)組。
| default |
PortOverrides | array<object> | 否 | 端口映射關(guān)系。 | |
object | 否 | 端口映射關(guān)系。 | ||
ListenerPort | integer | 否 | 配置端口映射時的監(jiān)聽端口。 說明
| 443 |
EndpointPort | integer | 否 | 配置端口映射時的終端節(jié)點(diǎn)端口。 | 80 |
HealthCheckEnabled | boolean | 否 | 是否開啟健康檢查。取值:
| true |
Tag | array<object> | 否 | 終端節(jié)點(diǎn)組的標(biāo)簽。 | |
object | 否 | 終端節(jié)點(diǎn)組的標(biāo)簽。 | ||
Key | string | 否 | 終端節(jié)點(diǎn)組的標(biāo)簽鍵。一旦輸入該值,則不允許為空字符串。 最多支持 64 個字符,不能以 最多支持輸入 20 個標(biāo)簽鍵。 | test-key |
Value | string | 否 | 終端節(jié)點(diǎn)組的標(biāo)簽值。一旦輸入該值,可以為空字符串。 最多支持 128 個字符,不能以 最多支持輸入 20 個標(biāo)簽值。 | test-value |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Domain.NotFit | The domain is not fit the rule | 域名未備案 |
400 | Resource.QuotaFull | The resource quota is exceeded. | 該資源數(shù)量已達(dá)配額上限 |
400 | NotExist.ListenerPort | The listening port %s does not exist. | 監(jiān)聽端口 %s 不存在 |
400 | NoPermission.EnableHealthCheck | You do not have permission to enable health check. | 該賬號沒有啟用健康檢查的權(quán)限。 |
400 | NotExist.Listener | The listener does not exist. | 監(jiān)聽器不存在 |
400 | NotActive.Listener | The state of the listener is not active. | 監(jiān)聽器狀態(tài)非穩(wěn)態(tài) |
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速實(shí)例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速實(shí)例狀態(tài)非法。 |
400 | NotExist.BusinessRegion | The business region does not exist. | 業(yè)務(wù)region并不存在 |
400 | NotExist.BasicBandwidthPackage | You must specify the basic bandwidth package. | 缺少基礎(chǔ)帶寬包 |
400 | QuotaExceeded.EndPoint | The maximum number of endpoints is exceeded. | 終端節(jié)點(diǎn)達(dá)到Quota限制 |
400 | Exist.EndpointGroup | The endpoint group already exists. | 終端節(jié)點(diǎn)組已存在 |
400 | NoPermission.VpcEndpoint | You are not authorized to perform the operation. | 用戶沒有創(chuàng)建服務(wù)關(guān)聯(lián)角色的權(quán)限,請聯(lián)系主賬號或權(quán)限管理員授權(quán)當(dāng)前用戶AliyunGlobalAccelerationFullAccess或者創(chuàng)建服務(wù)關(guān)聯(lián)角色的自定義權(quán)限。自定義權(quán)限策略的相關(guān)信息包含以下內(nèi)容:ServiceName為vpcendpoint.ga.aliyuncs.com,服務(wù)關(guān)聯(lián)角色名稱為AliyunServiceRoleForGaVpcEndpoint,執(zhí)行該操作所需的用戶權(quán)限為ram:CreateServiceLinkedRole。 |
400 | EndPointRequestProtocolIllegal.EndpointGroup | endpoint group request protoco is illegal | - |
400 | QuotaExceeded.PortOverride | The number of port override exceeds the limit. | 端口轉(zhuǎn)發(fā)數(shù)量超過限制 |
400 | NotExist.ListenerPort | listener port %s is not exist | - |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 處理請求時出現(xiàn)錯誤,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-07-20 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-11-22 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-09-14 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-06-20 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-04-20 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-03-31 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |