本產(chǎn)品（
云數(shù)據(jù)庫 Tair（兼容 Redis?）/2015-01-01）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機(jī)制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機(jī)制進(jìn)行自簽名對接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進(jìn)行簽名對接。在使用API前，您需要準(zhǔn)備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請參見獲取AccessKey。
生命周期管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateInstance | 創(chuàng)建一個Redis實例 | 創(chuàng)建一個Redis實例。 |
| AddShardingNode | 為Redis集群實例添加數(shù)據(jù)分片節(jié)點 | 為Redis集群實例添加數(shù)據(jù)分片節(jié)點。 |
| CreateGlobalDistributeCache | 將存量實例轉(zhuǎn)換為分布式實例中第一個子實例 | 將一個存量的Redis實例轉(zhuǎn)換為分布式實例中第一個子實例。 |
| DeleteShardingNode | 刪除Redis集群實例中的數(shù)據(jù)分片節(jié)點 | 刪除Redis集群實例中的數(shù)據(jù)分片節(jié)點。 |
| DeleteInstance | 釋放Redis實例 | 釋放Redis實例。 |
| ModifyInstanceSpec | 變更Redis實例的規(guī)格 | 變更Redis實例的規(guī)格。 |
| DescribeRegions | 查詢可用的地域 | 查詢Redis實例支持的所有地域及其對應(yīng)可用區(qū)信息。 |
| DescribeZones | 查詢支持的可用區(qū) | 查詢指定地域下Redis支持的可用區(qū)。 |
| DescribeAvailableResource | 查詢某一可用區(qū)的資源列表 | 查詢指定可用區(qū)內(nèi)可創(chuàng)建的實例規(guī)格。 |
| TransformToPrePaid | 將按量付費轉(zhuǎn)換為包年包月 | 將按量付費的Redis實例轉(zhuǎn)換為包年包月（預(yù)付費）實例。 |
| MigrateToOtherZone | 遷移實例至其他可用區(qū) | 將Redis實例遷移到同地域內(nèi)的其它可用區(qū)。 |
實例管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateTairInstance | 創(chuàng)建Tair實例 | 創(chuàng)建Tair版實例。 |
| CreateInstances | 批量創(chuàng)建Redis實例 | 批量創(chuàng)建Redis實例。 |
| EnableAdditionalBandwidth | 調(diào)整實例帶寬 | 調(diào)整Redis實例的帶寬，當(dāng)前僅支持按量付費的計費方式，您僅需填寫InstanceId、NodeId（可選）、Bandwidth、ChargeType參數(shù)即可。 |
| ModifyInstanceAttribute | 修改實例部分信息 | 修改一臺實例的部分信息，包括實例密碼、名稱。 |
| ModifyResourceGroup | 修改實例所屬資源組 | 修改Redis實例所屬的資源組。 |
| ModifyInstanceMaintainTime | 修改可維護(hù)時間段 | 修改Redis實例的可維護(hù)時間段，阿里云將在您設(shè)定的可維護(hù)時間段內(nèi)對Redis實例進(jìn)行例行維護(hù)。 |
| ModifyInstanceMajorVersion | 升級大版本 | 升級Redis實例的大版本。 |
| ModifyInstanceMinorVersion | 升級小版本 | 升級Redis實例的小版本。 |
| ModifyDBInstanceAutoUpgrade | 修改小版本自動升級開關(guān) | 修改小版本自動升級開關(guān) |
| DescribeInstancesOverview | 查詢實例概覽 | 查詢一個或多個Redis實例的信息概覽。 |
| DescribeInstances | 查詢實例的列表信息 | 查詢一個或多個Redis實例的信息。 |
| DescribeDedicatedClusterInstanceList | 查看專屬集群實例的列表 | 查詢專屬集群中的Redis實例信息。 |
| DescribeInstanceAttribute | 查詢Redis實例的詳細(xì)信息 | 查詢Redis實例的詳細(xì)信息。 |
| DescribeGlobalDistributeCache | 查詢分布式實例的詳細(xì)信息 | 查詢分布式實例的詳細(xì)信息。 |
| DescribeEngineVersion | 查詢Redis實例的大版本和小版本信息 | 查詢Redis實例的大版本和小版本信息，同時可查詢到小版本的發(fā)布日志信息。 |
| DescribeRoleZoneInfo | 查詢節(jié)點和所屬可用區(qū)信息 | 查詢Redis實例中各節(jié)點的角色、類型、小版本和所屬的可用區(qū)。 |
| DescribeClusterMemberInfo | 查詢集群的節(jié)點配置信息 | 查詢Redis集群實例的節(jié)點配置信息（例如規(guī)格、最大連接數(shù)等）。 |
| DescribeTasks | 查詢實例某個時間段內(nèi)所有任務(wù)信息 | 查詢Redis實例某個時間段內(nèi)運行的所有任務(wù)信息。 |
| DescribeDBInstanceNetInfo | 查看Redis實例的網(wǎng)絡(luò)信息 | 查看Redis實例的網(wǎng)絡(luò)信息。 |
| DescribeDBNodeDirectVipInfo | 查詢直連實例子實例的VIP | 查詢集群版直連實例的子實例VIP（Virtual IP Address）信息。 |
| DescribeLogicInstanceTopology | 查詢Redis實例的邏輯拓?fù)浣Y(jié)構(gòu) | 查詢Redis實例的邏輯拓?fù)浣Y(jié)構(gòu)。 |
| RestartInstance | 重啟實例 | 重啟運行中的Redis實例。 |
| FlushExpireKeys | 清除過期Key | 清除Redis實例中的過期Key。 |
| FlushInstanceForDB | 清理實例指定DB的數(shù)據(jù) | 清理實例中指定DB的數(shù)據(jù)。 |
| FlushInstance | 清空實例中的數(shù)據(jù) | 清空Redis實例中的數(shù)據(jù)，不可恢復(fù)。 |
| SwitchInstanceHA | 切換實例HA | 執(zhí)行主從切換（即切換節(jié)點角色），可應(yīng)用于容災(zāi)演練、多可用區(qū)場景下的應(yīng)用就近連接等需求。 |
| SyncDtsStatus | 設(shè)置是否限制實例變配 | 在使用DTS遷移或同步Redis實例的數(shù)據(jù)前，您可以調(diào)用SyncDtsStatus可以限制該Redis實例執(zhí)行變配操作，避免因變配引起的數(shù)據(jù)遷移或同步任務(wù)失敗。 |
| RemoveSubInstance | 將子實例轉(zhuǎn)換為普通實例 | 將子實例從分布式實例中移除并轉(zhuǎn)變?yōu)槠胀≧edis實例（數(shù)據(jù)會被保留）。 |
| LockDBInstanceWrite | 鎖定實例寫操作 | 鎖定后，實例將僅支持讀取數(shù)據(jù)，不支持寫入。 |
| UnlockDBInstanceWrite | 解鎖實例寫鎖定操作 | 對寫鎖定的實例進(jìn)行解鎖，解鎖后，實例支持讀取、寫入數(shù)據(jù)。 |
連接管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyInstanceNetExpireTime | 延長經(jīng)典網(wǎng)絡(luò)地址的保留時間 | 若Redis實例之前執(zhí)行過由經(jīng)典網(wǎng)絡(luò)向VPC網(wǎng)絡(luò)切換，并保留了經(jīng)典網(wǎng)絡(luò)連接地址，則可調(diào)用ModifyInstanceNetExpireTime延長經(jīng)典網(wǎng)絡(luò)連接地址的保留時間。 |
| ModifyDBInstanceConnectionString | 修改實例的連接地址和端口 | 修改Redis實例的連接地址和端口。 |
| ModifyIntranetAttribute | 調(diào)整專屬集群中Redis實例的內(nèi)網(wǎng)帶寬 | 臨時調(diào)整專屬集群中Redis實例的內(nèi)網(wǎng)帶寬。 |
| DescribeIntranetAttribute | 查詢實例的帶寬信息 | 查詢Redis實例當(dāng)前的帶寬。 |
| SwitchNetwork | 切換專有網(wǎng)絡(luò)VPC或交換機(jī) | 切換Redis實例的專有網(wǎng)絡(luò)VPC或交換機(jī)，如果Redis實例為經(jīng)典網(wǎng)絡(luò)，則會將其切換為專有網(wǎng)絡(luò)。 |
| AllocateInstancePublicConnection | 為實例申請公網(wǎng)連接地址 | 為Redis實例申請公網(wǎng)連接地址。 |
| ReleaseInstancePublicConnection | 釋放公網(wǎng)連接地址 | 釋放Redis實例的公網(wǎng)連接地址。 |
| AllocateDirectConnection | 為Redis集群實例申請直連地址 | 為Redis集群實例申請直連地址。 |
| ReleaseDirectConnection | 釋放Redis集群實例的直連地址 | 釋放Redis集群實例的直連地址。 |
| SwitchInstanceProxy | 開啟或關(guān)閉Redis集群實例的代理模式 | 開啟或關(guān)閉專屬集群中Redis集群實例的代理模式。 |
續(xù)費管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyInstanceAutoRenewalAttribute | 開啟或關(guān)閉實例自動續(xù)費 | 開啟或者關(guān)閉Redis實例的到期前自動續(xù)費功能。 |
| DescribePrice | 查詢價格 | 查詢創(chuàng)建Redis實例、升級配置或續(xù)費等操作產(chǎn)生的費用。 |
| DescribeInstanceAutoRenewalAttribute | 查詢實例是否開通自動續(xù)費 | 查看Redis實例是否開通自動續(xù)費。 |
| RenewAdditionalBandwidth | 帶寬續(xù)費 | 為購買的Redis實例帶寬續(xù)費。 |
| TransformInstanceChargeType | 轉(zhuǎn)換付費類型 | 轉(zhuǎn)換Redis實例的付費類型，支持按量付費和包年包月付費類型之間的相互轉(zhuǎn)換。 |
| RenewInstance | 手動續(xù)費 | 為Redis實例續(xù)費。 |
賬號管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAccount | 創(chuàng)建賬號 | 可以在Redis實例中創(chuàng)建有特定權(quán)限的賬號。 |
| DeleteAccount | 刪除賬號 | 刪除一個Redis賬號。 |
| ModifyAccountDescription | 修改Redis賬號的描述 | 修改Redis賬號的描述。 |
| ModifyAccountPassword | 修改賬號密碼 | 修改Redis實例中指定賬號的密碼。 |
| DescribeAccounts | 查找賬號信息 | 查找指定Redis實例的帳戶列表信息或?qū)嵗心硞€賬號的信息。 |
| ResetAccountPassword | 重置密碼 | 重置Redis賬號的密碼。 |
| GrantAccountPrivilege | 修改Redis賬號的權(quán)限 | 修改Redis賬號的權(quán)限。 |
備份恢復(fù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateBackup | 手動備份數(shù)據(jù) | 為Redis實例創(chuàng)建數(shù)據(jù)備份。 |
| ModifyBackupPolicy | 修改備份策略設(shè)置 | 修改Redis實例的自動備份策略。 |
| DescribeBackupTasks | 查詢備份任務(wù)執(zhí)行情況 | 查詢Redis實例的備份任務(wù)執(zhí)行情況。 |
| DescribeBackupPolicy | 查詢自動備份策略 | 查詢Redis實例的備份策略，包括備份周期、備份時間等。 |
| DescribeBackups | 查看備份集列表 | 查詢Redis實例的備份文件信息。 |
| RestoreInstance | 恢復(fù)Redis數(shù)據(jù) | 恢復(fù)指定備份文件中的數(shù)據(jù)到Redis實例中。 |
| DescribeClusterBackupList | 查詢集群實例的備份列表 | 查看Redis、Tair集群實例的備份列表。 |
監(jiān)控管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeMonitorItems | 查詢Redis監(jiān)控項列表 | 查詢Redis實例支持的監(jiān)控項列表。 |
| DescribeHistoryMonitorValues | 查看Redis實例的性能監(jiān)控信息 | 查看Redis實例的性能監(jiān)控信息。 |
日志管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyAuditLogConfig | 修改審計日志設(shè)置 | 開啟或修改Redis實例的審計日志設(shè)置。 |
| DescribeAuditLogConfig | 查詢審計日志配置 | 查詢Redis實例審計日志是否開啟、日志保存時間等配置信息。 |
| DescribeAuditRecords | 查詢Redis實例的審計日志 | 查詢Redis實例的審計日志。 |
| DescribeRunningLogRecords | 查詢Redis實例的運行日志列表 | 查詢Redis實例的運行日志。 |
| DescribeSlowLogRecords | 查看慢日志明細(xì) | 查詢Redis實例在指定時間內(nèi)產(chǎn)生的慢日志。 |
| InitializeKvstorePermission | 為Redis授權(quán)服務(wù)關(guān)聯(lián)角色 | 為云數(shù)據(jù)庫Redis授權(quán)服務(wù)關(guān)聯(lián)角色。 |
網(wǎng)絡(luò)安全
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifySecurityIps | 修改IP白名單 | 設(shè)置Redis實例的IP白名單。 |
| ModifySecurityGroupConfiguration | 設(shè)置Redis實例白名單中的安全組 | 設(shè)置Redis實例白名單中的安全組。 |
| ModifyInstanceSSL | 修改TLS（SSL）配置 | 為Redis實例開啟TLS（Transport Layer Security）加密協(xié)議配置。 |
| ModifyInstanceVpcAuthMode | 修改專有網(wǎng)絡(luò)免密訪問設(shè)置 | 開啟或關(guān)閉專有網(wǎng)絡(luò)免密訪問，可在保障安全性的前提下，實現(xiàn)更便捷的數(shù)據(jù)庫連接。 |
| DescribeSecurityIps | 查詢實例的IP白名單 | 查詢 Redis 實例的 IP 白名單。 |
| DescribeSecurityGroupConfiguration | 查詢已配置的安全組 | 查看Redis白名單中設(shè)置的安全組。 |
| DescribeInstanceSSL | 查詢是否開啟TLS（SSL）加密 | 查詢實例是否開啟了TLS（SSL）加密認(rèn)證。 |
參數(shù)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyInstanceConfig | 修改Redis實例的參數(shù)配置 | 修改Redis實例的參數(shù)配置。 |
| DescribeParameterTemplates | 查詢參數(shù)列表和默認(rèn)值 | 查詢Redis實例在不同架構(gòu)和大版本下的參數(shù)列表和默認(rèn)值。 |
| DescribeInstanceConfig | 查詢實例參數(shù)配置 | 查詢Redis實例的部分默認(rèn)配置參數(shù)信息。 |
| DescribeParameters | 查詢Redis實例的配置參數(shù)和運行參數(shù) | 查詢Redis實例的配置參數(shù)和運行參數(shù)。 |
| DescribeParameterModificationHistory | 查詢參數(shù)修改歷史 | 查詢Tair或Redis實例的參數(shù)修改歷史。 |
標(biāo)簽管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTagResources | 查詢標(biāo)簽列表 | 查詢Redis實例和標(biāo)簽的綁定關(guān)系。 |
| TagResources | 為一個或多個Redis實例綁定標(biāo)簽 | 為一個或多個Redis實例綁定標(biāo)簽。 |
| UntagResources | 為實例解綁標(biāo)簽 | 將標(biāo)簽從Redis實例解綁。 |
性能優(yōu)化
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateCacheAnalysisTask | 創(chuàng)建緩存分析任務(wù) | 手動發(fā)起Redis緩存分析任務(wù)。 |
| DescribeCacheAnalysisReport | 查看實例緩存分析報告 | 查看Redis實例在指定日期中的緩存分析報告。 |
| DescribeCacheAnalysisReportList | 查詢Redis實例的緩存分析報告列表 | 查詢Redis實例的緩存分析報告列表。 |
數(shù)據(jù)加密
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyInstanceTDE | 開啟透明數(shù)據(jù)加密TDE | 為Redis實例開啟透明數(shù)據(jù)加密TDE功能，支持自定義密鑰。 |
| DescribeInstanceTDEStatus | 查詢實例是否開啟TDE加密 | 查詢Redis實例是否開啟了TDE加密功能。 |
| DescribeEncryptionKeyList | 查詢實例的自定義密鑰列表 | 查詢Redis使用的自定義密鑰列表。 |
| DescribeEncryptionKey | 查詢實例的TDE自定義密鑰詳情 | 查詢Redis實例的透明數(shù)據(jù)加密TDE自定義密鑰的詳情。 |
| CheckCloudResourceAuthorized | 查詢是否已授權(quán)KMS密鑰 | 查詢Redis實例是否已被授權(quán)使用KMS密鑰服務(wù)。 |
運維任務(wù)管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeHistoryTasks | 查詢歷史運維任務(wù) | 查看任務(wù)中心的任務(wù)列表。 |
| ModifyActiveOperationTask | 修改運維任務(wù)的計劃切換時間 | 修改運維任務(wù)的計劃切換時間。 |
| DescribeActiveOperationTask | 查詢運維任務(wù)詳情 | 查詢Redis實例的運維任務(wù)詳情。 |
白名單模板管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateGlobalSecurityIPGroup | 創(chuàng)建IP白名單模板 | 創(chuàng)建全局IP白名單模板。 |
| ModifyGlobalSecurityIPGroupName | 修改IP白名單模板名稱 | 修改全局IP白名單模板的名稱。 |
| DescribeGlobalSecurityIPGroupRelation | 查詢實例關(guān)聯(lián)的IP白名單模板信息 | 查詢實例關(guān)聯(lián)的全局IP白名單模板信息。 |
| DeleteGlobalSecurityIPGroup | 刪除IP白名單模板 | 刪除全局IP白名單模板。 |
| ModifyGlobalSecurityIPGroup | 修改IP白名單模板 | 修改全局IP白名單模板。 |
| ModifyGlobalSecurityIPGroupRelation | 將實例添加到IP白名單模板中 | 將指定實例添加到指定的IP白名單模板中。 |
| DescribeGlobalSecurityIPGroup | 查詢IP白名單模板列表 | 查詢?nèi)諭P白名單模板列表。 |
參數(shù)模板管理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ModifyInstanceParameter | 應(yīng)用參數(shù)模板到實例 | 將參數(shù)模板應(yīng)用至指定實例，表示將參數(shù)模板的值賦于指定的實例中。當(dāng)您修改參數(shù)模版后，您也需要重新應(yīng)用至指定實例，才能將修改后的參數(shù)值賦于指定實例。 |
| DeleteParameterGroup | 刪除參數(shù)模板 | 刪除參數(shù)模板。 |
| DescribeParameterGroupSupportParam | 參數(shù)模版支持設(shè)置的參數(shù)列表 | 查詢在不同版本的參數(shù)模版中支持設(shè)置的參數(shù)列表。 |
| DescribeParameterGroup | 查詢參數(shù)模版基本信息 | 查詢參數(shù)模版基本信息。 |
| ModifyParameterGroup | 修改參數(shù)模版 | 修改參數(shù)模板的設(shè)置。 |
| DescribeParameterGroups | 查詢參數(shù)模版列表 | 查詢可用的參數(shù)模版列表。 |
| CreateParameterGroup | 創(chuàng)建參數(shù)模板 | 創(chuàng)建參數(shù)模板。 |
| DescribeParameterGroupTemplateList | 參數(shù)模版系統(tǒng)參數(shù) | 查詢參數(shù)模板中可配置參數(shù)的具體信息，例如默認(rèn)值、取值范圍、描述等。 |
其他
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeActiveOperationTasks | 查詢多個主動運維任務(wù)信息 | 查詢redis實例的運維任務(wù)詳情。 |
| ModifyActiveOperationTasks | 修改運維任務(wù)的計劃切換時間 | 該接口用于修改 Redis 實例計劃內(nèi)運維任務(wù)的切換時間。 |
| ModifyInstanceBandwidth | 修改實例的帶寬 | 設(shè)置實例的目標(biāo)帶寬值。 |