調用CreateBasicEndpoint接口為基礎型全球加速實例創建終端節點。
接口說明
- CreateBasicEndpoint 接口屬于異步接口,即系統會先返回一個基礎型全球加速實例終端節點 ID,但終端節點未創建完成,系統后臺的創建任務仍在進行。您可以調用 ListBasicEndpoints 查詢終端節點的狀態:
- 當終端節點狀態為 init 時,表示終端節點正在創建中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
- 當終端節點狀態為 active 時,表示終端節點已創建完成。
- CreateBasicEndpoint 接口不支持在同一個基礎型全球加速實例內并發創建終端節點。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:CreateBasicEndpoint | 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**** |
EndpointGroupId | string | 是 | 基礎型全球加速實例的終端節點組 ID。 | epg-bp1dmlohjjz4kqaun**** |
Name | string | 否 | 基礎型全球加速實例終端節點的名稱。 名稱長度為 1~128 個字符,以大小寫字母或中文開頭,可包含數字、半角句號(.)下劃線(_)和短劃線(-)。 | ep01 |
EndpointType | string | 是 | 終端節點類型。取值:
| ENI |
EndpointAddress | string | 是 | 終端節點的地址。 | eni-bp1a05txelswuj8g**** |
EndpointSubAddress | string | 否 | 終端節點輔助地址。 當終端節點類型為 ECS、ENI 或 NLB 時,需配置該參數。
| 172.16.XX.XX |
EndpointSubAddressType | string | 否 | 終端節點輔助地址的類型。取值:
當終端節點類型為 ECS、ENI 或 NLB 時,需配置該參數。其中,終端節點類型為 NLB 時,僅支持 primary 類型。 | primary |
EndpointZoneId | string | 否 | 終端節點所在可用區 ID。 目前,僅當終端節點類型為 NLB 時,需要輸入該參數。 | cn-hangzhou-g |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
"EndpointId": "ep-bp14sz7ftcwwjgrdm****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速實例不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-04-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |