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