開啟或關閉專屬集群中云數據庫 Tair(兼容 Redis)集群實例的代理模式。
接口說明
關于代理模式的詳細介紹,請參見 Proxy 特性說明。 調用本接口時,需滿足下述條件:
- 實例是通過專屬集群創建的,更多信息,請參見云數據庫專屬集群 MyBase。
- 實例為集群架構。
說明
調用本接口前,您需要調用 DescribeDedicatedClusterInstanceList 接口,通過返回參數 ProxyCount 的值來判斷當前實例是否開啟了代理模式。例如,返回值為 0 時,表示未開啟代理模式;返回值大于 0 時,即表示已開啟代理模式。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:SwitchInstanceProxy | update | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID,可調用 DescribeInstances 獲取。 | r-bp1zxszhcgatnx**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-20 | OpenAPI 描述信息更新 | 查看變更詳情 |