調用CreateBasicEndpointGroup接口創建基礎型全球加速實例的終端節點組。
接口說明
- CreateBasicEndpointGroup 接口屬于異步接口,即系統會先返回一個終端節點組 ID,但終端節點組未創建完成,系統后臺的創建任務仍在進行。您可以調用 GetBasicEndpointGroup 查詢終端節點組的狀態:
- 當終端節點組處于 init 狀態時,表示終端節點組正在創建中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
- 當終端節點組處于 active 狀態時,表示終端節點組創建完成。
- CreateBasicEndpointGroup 接口不支持在同一個基礎型全球加速實例內并發創建終端節點組。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:CreateBasicEndpointGroup | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 基礎型全球加速實例所在的地域 ID,僅取值:cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-426655440000 |
AcceleratorId | string | 是 | 基礎型全球加速實例 ID。 | ga-bp17frjjh0udz4qz**** |
EndpointGroupRegion | string | 是 | 基礎型全球加速實例的終端節點組所在的地域 ID。 您可以通過調用 ListAvailableBusiRegions 接口獲取地域 ID。 | cn-shanghai |
Name | string | 否 | 基礎型全球加速實例的終端節點組的名稱。 名稱長度為 1~128 個字符,以大小寫字母或中文開頭,可包含數字、半角句號(.)下劃線(_)和短劃線(-)。 | group1 |
Description | string | 否 | 基礎型全球加速實例的終端節點組描述信息。 描述長度最大 200 字符,不能以 | BasicEndpointGroup |
EndpointType | string | 否 | 終端節點類型。取值:
| ENI |
EndpointAddress | string | 否 | 終端節點的地址。 | eni-bp1a05txelswuj8g**** |
EndpointSubAddress | string | 否 | 終端節點輔助地址。 當加速 IP 綁定到 ECS 輔助私網 IP 地址或 ENI 輔助私網 IP 時,需配置該參數。
| 172.16.XX.XX |
返回參數
示例
正常返回示例
JSON
格式
{
"EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Resource.QuotaFull | The resource quota is exceeded. | 該資源數量已達配額上限 |
400 | NoPermission.EnableHealthCheck | You do not have permission to enable health check. | 該賬號沒有啟用健康檢查的權限。 |
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速實例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速實例狀態非法。 |
400 | NotExist.BusinessRegion | The business region does not exist. | 業務region并不存在 |
400 | NotExist.BasicBandwidthPackage | You must specify the basic bandwidth package. | 缺少基礎帶寬包 |
400 | Exist.EndpointGroup | The endpoint group already exists. | 終端節點組已存在 |
400 | QuotaExceeded.EndpointGroup | The number of endpoint group exceeds the limit. | 終端節點組數量超過限制額度。 |
400 | EcsCannotBind.BasicEndpoint | The ECS instance has already been associated with another EIP. | 該ECS實例不可被綁定,因為實例已經被其它EIP綁定。 |
400 | InvalidateRegion.BasicAccelerator | The region of the endpoint group and the acceleration region cannot be the same. | 終端節點組地域和加速區域不可以在同一區域。 |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 處理請求時出現錯誤,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-04-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-04-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |