全部產品
Search

搜尋本產品

    ：CreateStorageAnalysisTask - 建立空間分析任務

    文件中心

    ：CreateStorageAnalysisTask - 建立空間分析任務

    更新時間：Dec 19, 2025

    調用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 執行個體各個節點的詳細資料。

    • 當傳入目標節點的 InsName（節點 ID）時，例如d-bp1872fa24d5****，調用該介面分析其對應的 Hidden 節點。

    • 當傳入目標節點的InsName#RoleId時，例如d-bp1872fa24d5****#299****5，調用該介面分析指定的節點。

    重要 對於 MongoDB 複本集執行個體，不傳入此參數時，調用該介面會預設分析唯一的 Hidden 節點。對於 MongoDB 分區叢集執行個體，推薦傳入此參數，指定目標節點。

    d-bp1872fa24d5****
    DbName

    string

    否

    資料庫名。傳入該參數時，分析指定資料庫的空間使用方式。

    testdb01
    TableName

    string

    否

    表名。傳入該參數時，分析指定資料庫中指定表的空間使用方式。傳入該參數時，必須同時傳入 DbName，指定該表所屬的資料庫。

    test_table

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    integer

    返回的狀態代碼。

    200
    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    Data

    object

    返回的資料。

    TaskId

    string

    任務 ID。

    910f83f4b96df0524ddc5749f61539f8
    CreateTaskSuccess

    boolean

    建立任務是否成功：

    • true：執行成功。

    • false：執行失敗。

    false
    ErrorMessage

    string

    建立任務失敗時的錯誤提示。

    unknown error
    RequestId

    string

    請求 ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    boolean

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true

    樣本

    正常返回樣本

    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。