搜索庫詳情信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dms:SearchDatabase | list | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tid | long | 否 | 租戶 ID，可通過調用接口 GetUserActiveTenant 獲取該參數的值。 | 3*** |
| SearchKey | string | 是 | 搜索數據庫名稱的關鍵字。 | testdb |
| PageNumber | integer | 是 | 第幾頁。 | 1 |
| PageSize | integer | 否 | 每頁記錄數。 | 10 |
| EnvType | string | 否 | 數據庫的環境類型，更多信息，請參見實例環境說明。 | test |
| SearchRange | string | 否 | 權限范圍，取值如下：
| HAS_PERMSSION |
| SearchTarget | string | 否 | 搜索目標，取值如下：
| SINGLE_DB |
| DbType | string | 否 | 數據庫類型，取值請參見 DbType 參數說明。 | MYSQL |
返回參數
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
"SearchDatabaseList": {
"SearchDatabase": [
{
"DatabaseId": "2528****",
"Host": "rm-xxxx.mysql.rds.aliyuncs.com",
"DbaId": "10****",
"SchemaName": "test",
"Logic": false,
"DatalinkName": "datalink_name",
"Port": 3306,
"EnvType": "test",
"Sid": "testSid",
"OwnerIdList": {
"OwnerIds": [
"1"
]
},
"Encoding": "utf8",
"DbType": "mysql",
"OwnerNameList": {
"OwnerNames": [
"user1"
]
},
"SearchName": "test@xxx.xxx.xxx.xxx:3306",
"Alias": "test_rds",
"CatalogName": "dmstest"
}
]
},
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-22 | API 內部配置變更，不影響調用 | 查看變更詳情 |