API標準及多語言預置SDK
本產品（selectdb/2023-05-22）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
執行個體管理
|
API |
標題 |
API概述 |
| CreateServiceLinkedRoleForSelectDB | 建立服務關聯角色 | 調用該介面建立服務關聯角色。 |
| CheckCreateDBInstance | 建立執行個體前的預檢查 | 建立雲資料庫SelectDB版執行個體前的預檢查。 |
| DescribeSecurityIPList | 查詢執行個體白名單IP | 查詢指定雲資料庫SelectDB版執行個體的白名單IP。 |
| ModifySecurityIPList | 修改白名單 | 修改指定雲資料庫SelectDB版執行個體的白名單IP。 |
| CheckIpExistsInSecurityIpList | 判斷指定 IP 是否已經存在於網路白名單組 | 判斷指定 IP 是否已經存在於網路白名單組。 |
| ModifyDBInstanceAttribute | 修改執行個體營運時間或備忘資訊 | 修改指定雲資料庫SelectDB版執行個體的營運時間或備忘資訊。 |
叢集管理
|
API |
標題 |
API概述 |
| ModifyVirtualCluster | 修改虛擬叢集 | 修改虛擬叢集。 |
| CreateDBClusterBinding | 建立叢集綁定 | 部署模式為同城冗餘的執行個體，兩個叢集間可建立互相綁定關係。 |
| DeleteDBClusterBinding | 刪除叢集綁定 | 刪除兩叢集間的互備綁定關係。 |
| GetCreateBEClusterInquiry | 建立叢集詢價 | 指定雲資料庫SelectDB版執行個體下建立叢集時擷取價格資訊。 |
| GetModifyBEClusterInquiry | 叢集變更配置詢價 | 指定雲資料庫SelectDB版執行個體下建立叢集時擷取價格資訊。 |
| ModifyBEClusterAttribute | 修改叢集名 | 修改雲資料庫SelectDB版執行個體的叢集名稱。 |
| StopBECluster | 停止叢集 | 停止指定雲資料庫SelectDB版叢集。 |
| StartBECluster | 啟動叢集 | 啟動指定雲端資料庫SelectDB版叢集。 |
| RestartDBCluster | 重啟叢集 | 重啟指定雲資料庫SelectDB版執行個體的叢集。 |
| DescribeDBClusterConfig | 查看叢集配置 | 查看叢集配置。 |
| ModifyDBClusterConfig | 修改叢集配置 | 修改叢集配置。 |
| DescribeDBClusterConfigChangeLogs | 查看叢集配置變更記錄 | 查看叢集配置變更記錄。 |
其他
|
API |
標題 |
API概述 |
| DescribeAllDBInstanceClass | 擷取所有執行個體規格資訊 | 擷取所有執行個體規格資訊。 |
| ModifyElasticRule | 修改分時彈性規則 | 修改分時彈性規則。 |
| DescribeElasticRules | 查詢分時彈性規則 | 查詢分時彈性規則。 |
| DescribeDBClusterStorageLimitation | 查看叢集各規格緩衝限制 | 擷取叢集的各規格緩衝限制 |
| DeleteElasticRule | 刪除分時彈性規則 | 刪除分時彈性規則。 |
| EnDisableScalingRules | 開關分時彈性策略 | 開關分時彈性策略。 |
| CreateElasticRule | 建立分時彈性規則 | 建立分時彈性規則。 |
Others
|
API |
標題 |
API概述 |
| AllocateInstancePublicConnection | 申請公網地址 | 為指定雲資料庫SelectDB版執行個體申請公網地址。 |
| ChangeResourceGroup | 執行個體轉資源群組 | 執行個體轉資源群組 |
| CheckServiceLinkedRole | 檢查服務關聯角色 | 調用該介面檢查服務關聯角色。 |
| CreateDBCluster | 建立叢集 | 為指定雲資料庫SelectDB版執行個體建立叢集。 |
| CreateDBInstance | 建立執行個體 | 建立一個雲端資料庫 SelectDB 版執行個體。 |
| CreateVirtualCluster | 建立虛擬叢集 | 建立虛擬叢集。 |
| DeleteDBCluster | 刪除叢集 | 刪除執行個體下叢集。 |
| DeleteDBInstance | 刪除執行個體 | 刪除指定雲資料庫SelectDB版執行個體。 |
| DeleteVirtualCluster | 刪除虛擬叢集 | 刪除虛擬叢集。 |
| DescribeDBInstanceAttribute | 查詢執行個體詳情 | 查詢執行個體詳情。 |
| DescribeDBInstanceNetInfo | 查詢執行個體網路資訊 | 查詢指定雲資料庫SelectDB版執行個體的網路資訊。 |
| DescribeDBInstances | 查詢執行個體 | 查詢執行個體列表。 |
| DescribeProfile | 查詢Profile資訊 | 擷取查詢Profile分析資訊。 |
| DescribeRegions | 擷取可選的地區和可用性區域 | 擷取可選的地區和可用性區域資訊。 |
| DescribeSlowQueryStats | 查詢慢查詢統計資訊 | 擷取指定時間段內慢查詢統計資訊 |
| DescribeVSwitches | 查詢交換器列表 | 列出可用性區域下交換器。 |
| DescribeZones | 列出售賣可用性區域 | 列出售賣可用性區域。 |
| ModifyDBCluster | 叢集擴縮容 | 為指定雲資料庫SelectDB版執行個體的叢集擴縮容。 |
| ReleaseInstancePublicConnection | 釋放公網地址 | 釋放指定雲資料庫SelectDB版執行個體的公網地址。 |
| ResetAccountPassword | 重設帳號密碼 | 重設雲資料庫SelectDB版執行個體的帳號密碼。 |
| TagResources | 執行個體打標籤 | 執行個體打標籤 |
| UntagResources | 執行個體去除標籤 | 執行個體去除標籤 |
| UpgradeDBInstanceDeployScheme | 升級執行個體可用性區域部署架構 | 將本地冗餘執行個體升級為同城冗餘。 |
| UpgradeDBInstanceEngineVersion | 升級資料庫版本 | 升級指定雲資料庫SelectDB版執行個體的資料庫版本。 |