全部產品
Search
文件中心

:GetAutoResourceOptimizeRules - 擷取空間片段自動回收規則

更新時間:Dec 19, 2025

擷取指定資料庫執行個體的空間片段自動回收規則。

介面說明

使用該介面需滿足以下前提條件:

  • 在使用 SDK 調用 DAS 服務時,需要將地區指定為 cn-shanghai。

  • 執行個體類型為 RDS MySQL 高可用系列。

  • 資料庫執行個體的 CPU 規格不小於 4 核,且innodb_file_per_table參數值為 ON

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:GetAutoResourceOptimizeRules

none

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

ConsoleContext

string

備用參數。

None

InstanceIds

string

資料庫執行個體 ID。

  • 資料格式為 JSONArray,例如['執行個體 ID1','執行個體 ID2'],執行個體 ID 間用英文逗號(,)分隔。

  • 不輸入資料庫執行個體 ID 時,預設返回當前帳號曾經開啟過空間片段自動回收功能的全部資料庫執行個體資訊,包括:
    • 正在使用該功能的資料庫執行個體。

    • 已關閉該功能的資料庫執行個體(包含已經關閉了 DAS 企業版資料庫執行個體,但不包含已經釋放的資料庫執行個體)。

['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****','rm-2ze8g2am97627****']

返回參數

名稱

類型

描述

樣本值

object

Code

integer

返回的狀態代碼。

200

Message

string

請求返回訊息。

說明

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

Successful

Data

object

返回的資料。

TotalAutoResourceOptimizeRulesCount

integer

所有開啟過空間片段自動回收功能的資料庫執行個體數量。

3

EnableAutoResourceOptimizeCount

integer

正在使用空間片段自動回收功能的資料庫執行個體數量。

1

TurnOffAutoResourceOptimizeCount

integer

曾經開啟並且當前已關閉空間片段自動回收功能的資料庫執行個體數量。

1

HasEnableRuleButNotDasProCount

integer

已開啟並且未關閉空間片段自動回收功能,但已不再使用 DAS 企業版的資料庫執行個體數量。

1

EnableAutoResourceOptimizeList

array<object>

正在使用空間片段自動回收功能的資料庫執行個體資訊列表。

object

InstanceId

string

資料庫執行個體 ID。

rm-2ze8g2am97624****

AutoDefragment

boolean

是否開啟了自動空間片段回收功能。

  • true:是。

  • false:否。

true

TableSpaceSize

number

觸發空間片段自動回收單個物理表的最小空間,單位為 GB。

10

DasProOn

boolean

是否開啟了 DAS 企業版。

  • true:是。

  • false:否。

true

TableFragmentationRatio

number

觸發空間片段自動回收單個物理表的片段率。

0.2

UserId

string

使用者識別碼,即建立資料庫執行個體的阿里雲主帳號 ID。

140692647406****

TurnOffAutoResourceOptimizeList

array<object>

曾經開啟並且當前已關閉空間片段自動回收功能的資料庫執行個體資訊列表。

object

InstanceId

string

資料庫執行個體 ID。

rm-2vc54m2a6pd6p****

AutoDefragment

boolean

是否開啟了自動空間片段回收功能。

  • true:是。

  • false:否。

false

TableSpaceSize

number

觸發空間片段自動回收單個物理表的最小空間,單位為 GB。

10

DasProOn

boolean

是否開啟了 DAS 企業版。

  • true:是。

  • false:否。

true

TableFragmentationRatio

number

觸發空間片段自動回收單個物理表的片段率。

0.2

UserId

string

使用者識別碼,即建立資料庫執行個體的阿里雲主帳號 ID。

140692647406****

HasEnableRuleButNotDasProList

array<object>

已開啟並且未關閉空間片段自動回收功能,但已不再使用 DAS 企業版的資料庫執行個體列表。

說明

此類資料庫執行個體不會執行空間片段自動回收,直至再次為資料庫執行個體開啟 DAS 企業版。

object

InstanceId

string

資料庫執行個體 ID。

rm-2ze9xrhze0709****

AutoDefragment

boolean

是否開啟了自動空間片段回收功能。

  • true:是。

  • false:否。

true

TableSpaceSize

number

觸發空間片段自動回收單個物理表的最小空間,單位為 GB。

10

DasProOn

boolean

是否開啟了 DAS 企業版。

  • true:是。

  • false:否。

false

TableFragmentationRatio

number

觸發空間片段自動回收單個物理表的片段率。

0.2

UserId

string

使用者識別碼,即建立資料庫執行個體的阿里雲主帳號 ID。

140692647406****

NeverEnableAutoResourceOptimizeOrReleasedInstanceCount

integer

從未開啟過空間片段自動回收或者執行個體不存在的資料庫執行個體數量。

說明

執行個體不存在:資料庫執行個體已經釋放或者傳入的資料庫執行個體 ID 存在錯誤。

1

NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList

array

從未開啟過空間片段自動回收或者執行個體不存在的資料庫執行個體資訊列表。

string

資料庫執行個體 ID。

rm-2ze8g2am97624****

RequestId

string

請求 ID。

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

Success

boolean

請求是否執行成功:

  • true:執行成功。

  • false:執行失敗。

true

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TotalAutoResourceOptimizeRulesCount": 3,
    "EnableAutoResourceOptimizeCount": 1,
    "TurnOffAutoResourceOptimizeCount": 1,
    "HasEnableRuleButNotDasProCount": 1,
    "EnableAutoResourceOptimizeList": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "AutoDefragment": true,
        "TableSpaceSize": 10,
        "DasProOn": true,
        "TableFragmentationRatio": 0.2,
        "UserId": "140692647406****"
      }
    ],
    "TurnOffAutoResourceOptimizeList": [
      {
        "InstanceId": "rm-2vc54m2a6pd6p****",
        "AutoDefragment": false,
        "TableSpaceSize": 10,
        "DasProOn": true,
        "TableFragmentationRatio": 0.2,
        "UserId": "140692647406****"
      }
    ],
    "HasEnableRuleButNotDasProList": [
      {
        "InstanceId": "rm-2ze9xrhze0709****",
        "AutoDefragment": true,
        "TableSpaceSize": 10,
        "DasProOn": false,
        "TableFragmentationRatio": 0.2,
        "UserId": "140692647406****"
      }
    ],
    "NeverEnableAutoResourceOptimizeOrReleasedInstanceCount": 1,
    "NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList": [
      "rm-2ze8g2am97624****"
    ]
  },
  "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.

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

變更歷史

更多資訊,參考變更詳情