調用CreateSpareIps接口創建CNAME備用IP,當加速區域異常時,流量可切換到備用IP。
接口說明
-
CreateSpareIps 接口屬于異步接口,即系統會先返回一個請求 ID,但 CNAME 備用 IP 并未創建完成,系統后臺的創建任務仍在進行。您可以調用 DescribeAccelerator 查詢全球加速實例的狀態:
-
當全球加速實例處于 configuring 狀態時,表示全球加速實例的 CNAME 備用 IP 正在創建中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
-
當全球加速實例處于 active 狀態時,表示全球加速實例的 CNAME 備用 IP 創建完成。
-
-
CreateSpareIps 接口不支持在同一個全球加速實例內并發創建 CNAME 備用 IP。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:CreateSpareIps | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速實例所在的地域 ID,僅取值:cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 1F4B6A4A-C89E-489E-BAF1-52777EE148EF |
DryRun | boolean | 否 | 是否只預檢此次請求,取值:
| true |
AcceleratorId | string | 是 | 全球加速實例 ID。 | ga-bp1odcab8tmno0hdq**** |
SpareIps | array | 是 | CNAME 備用 IP 列表,當加速區域異常時,流量切換到備用 IP。 您最多可以輸入 2 個備用 IP。 | |
string | 是 | CNAME 備用 IP 列表,當加速區域異常時,流量切換到備用 IP。 您最多可以輸入 2 個備用 IP。 | 127.0.XX.XX |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | Duplicate.SpareIp | The spare IP address is duplicate. |
400 | AlreadyExist.SpareIp | The spare ip %s already exists. |
400 | IllegalParamFormat.SpareIp | The param format of spare ip is illegal. |
400 | QuotaExceeded.SpareIp | The number of spare ip exceeds the limit. |
400 | TooManySpareIp.Accelerator | Too many SpareIp accepted under the same Accelerator. |
400 | NoPermission.CreateSpareIp | You do not have permission to create spareIp. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-04-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |