刪除Redis集群實例中的數據分片節點。
接口說明
該 API 對應的控制臺操作請參見調整實例的分片數量。
調用本接口時,實例必須滿足以下條件:
- 實例為云原生版實例。
- 實例為集群架構。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DeleteShardingNode | delete |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | r-bp1zxszhcgatnx**** |
NodeIddeprecated | string | 是 | 待刪除的數據分片節點 ID,如需一次傳入多個分片節點 ID,請使用英文逗號(,)分隔。 說明
若同時傳遞 NodeId 與 ShardCount 參數時,優先以 NodeId 參數執行。
| r-bp1zxszhcgatnx****-db-0,r-bp1zxszhcgatnx****-db-1 |
ShardCount | integer | 是 | 待刪除的分片數量,將從尾部開始計數,刪除相應數量的分片節點。 說明
例如實例原有 5 個分片節點,分別為 db-0、db-1、db-2、db-3 和 db-4,輸入本參數為 2,則將刪除 db-3 和 db-4。
| 1 |
ForceTrans | boolean | 否 | 是否開啟強制傳輸,取值:
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
"OrderId": "22179******0904"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-04 | OpenAPI 入參發生變更 | 查看變更詳情 |
2022-07-14 | API 內部配置變更,不影響調用 | 查看變更詳情 |