調用CreateStorageAnalysisTask接口,創建空間分析任務,獲取數據庫及表的空間使用數據。
接口說明
- 本接口僅適用于 RDS MySQL、PolarDB MySQL 版和 MongoDB 實例。
- 對于 RDS MySQL 和 PolarDB MySQL 版實例,本接口對應于舊版空間分析功能,該接口生成的任務無法在 DAS 控制臺新版空間分析頁面查看。如有需要查看任務及結果,請調用接口獲取數據后自行保存。
- 使用阿里云或 DAS 的 SDK 時,建議使用最新版本。
- 在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hdm:CreateStorageAnalysisTask | none | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | rm-2ze1jdv45i7l6**** |
NodeId | string | 否 | 節點 ID。 對于 MongoDB 實例,通過該參數指定節點進行空間分析。調用 DescribeRoleZoneInfo 接口,可以查詢 MongoDB 實例各個節點的詳細信息。
注意 對于 MongoDB 副本集實例,不傳入此參數時,調用該接口會默認分析唯一的 Hidden 節點。對于 MongoDB 分片集群實例,推薦傳入此參數,指定目標節點。 | d-bp1872fa24d5**** |
DbName | string | 否 | 數據庫名。傳入該參數時,分析指定數據庫的空間使用情況。 | testdb01 |
TableName | string | 否 | 表名。傳入該參數時,分析指定數據庫中指定表的空間使用情況。傳入該參數時,必須同時傳入 DbName,指定該表所屬的數據庫。 | test_table |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Successful",
"Data": {
"TaskId": "910f83f4b96df0524ddc5749f61539f8",
"CreateTaskSuccess": false,
"ErrorMessage": "unknown error"
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。