設置云數據庫 Tair(兼容 Redis)實例的IP白名單。
接口說明
該 API 對應的控制臺操作請參見設置 IP 白名單。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:ModifySecurityIps | update | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | r-bp1zxszhcgatnx**** |
SecurityIps | string | 是 | IP 白名單分組下的 IP 列表,最多 1000 個。IP 之間以逗號隔開,格式如下:0.0.0.0/0,10.23.12.24,或者 10.23.12.24/24(CIDR 模式,無類域間路由,/24 表示地址中前綴的長度,范圍 1-32)。 | 100.64.***.0/24,10.101.11.*** |
SecurityIpGroupName | string | 否 | IP 白名單分組的名稱。 警告 不可修改系統生成白名單分組。如果不傳此字段,將默認修改 default 分組的白名單 | default |
SecurityIpGroupAttribute | string | 否 | 默認為空。用于區分不同的屬性值,控制臺將不顯示該值為 hidden 的白名單分組。 | hidden |
ModifyMode | string | 否 | 修改方式,取值:
| Append |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "AAAF99B1-69ED-4E80-8CD5-272C09E4****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Forbbiden.MinorVersion | The operation is not permitted for current minor version. | 當前版本該操作是不允許的。 |
400 | InvalidGroupName.Format | Sepecified group name is not valid. | - |
400 | LockTimeout | The request processing has failed due to lock timeout. | 當前請求與其他請求沖突,請稍后重試 |
404 | InvalidSecurityIPList.NotFound | Specified same security IP does not exist or at least one security IP need. | 白名單分組中未找到與指定IP相同的IP,或未傳入IP |
409 | SecurityIPList.Duplicate | Specified same security IP already exists. | 指定的白名單分組中已經包含了相同的IP |
訪問錯誤中心查看更多錯誤碼。