全部產品
Search

搜尋本產品

    Database Autonomy Service：GetAutoIncrementUsageStatistic - 擷取表自增ID使用資料

    文件中心

    Database Autonomy Service：GetAutoIncrementUsageStatistic - 擷取表自增ID使用資料

    更新時間：Apr 21, 2026

    調用GetAutoIncrementUsageStatistic介面，擷取表自增ID的使用資料。

    介面說明

    • 本介面只適用於 RDS MySQL 和 PolarDB MySQL 版執行個體。

    • 使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。

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

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hdm:GetAutoIncrementUsageStatistic

    none

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    執行個體 ID。

    rm-2ze8g2am97624****
    DbNames

    string

    否

    資料庫名。傳入此參數時，查詢指定資料庫中表自增 ID 使用方式，不傳入時查詢執行個體上所有資料庫的表自增 ID 使用方式。

    說明

    資料格式為 JSONArray，例如['db1','db2']，資料庫名間用英文逗號（,）分隔。

    ['db1','db2']
    RatioFilter

    number

    是

    自增 ID 使用比例過濾值，只返回超過該比例的自增 ID 使用資料。取值為 0~1 的小數。

    0.9
    RealTime

    boolean

    是

    是否擷取即時資料：

    • true：即時查詢執行個體上資料並計算。最小查詢時間粒紋為 10 分鐘，即有 10 分鐘內的資料時，即使傳遞 true 也不進行即時查詢。

    • false：當有近兩小時的資料時，返回該資料，否則查詢執行個體上最新資料。

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    integer

    返回的狀態代碼。

    200
    Message

    string

    請求返回訊息。

    說明

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

    Successful
    Data

    object

    返回的資料。

    Finish

    boolean

    任務是否結束：

    • true：任務結束。

    • false：任務未結束。

    false
    Timestamp

    integer

    執行時間，格式為 Unix 時間戳記，單位為毫秒（ms）。

    1697183353000
    TaskStatus

    string

    任務狀態：

    • INIT：初始化。

    • RUNNING：任務執行中。

    • SUCCESS：任務成功。

    • FAIL：任務失敗。

    INIT
    ErrorInfo

    string

    任務失敗時的錯誤資訊。

    the given database name list invalid, none of the database names in the list exist on the instance
    AutoIncrementUsageList

    array<object>

    自增 ID 使用資料列表。

    object

    DbName

    string

    資料庫名。

    db01
    TableName

    string

    表名。

    test_table
    ColumnName

    string

    列名。

    id
    AutoIncrementCurrentValue

    integer

    自增 ID 當前值。

    2147483647
    MaximumValue

    integer

    該資料類型的自增 ID 支援的最大值。

    2147483647
    AutoIncrementRatio

    number

    自增 ID 使用比例。

    1
    RequestId

    string

    請求 ID。

    0A74B755-98B7-59DB-8724-1321B394****
    Success

    boolean

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Finish": false,
    "Timestamp": 1697183353000,
    "TaskStatus": "INIT",
    "ErrorInfo": "the given database name list invalid, none of the database names in the list exist on the instance",
    "AutoIncrementUsageList": [
      {
        "DbName": "db01",
        "TableName": "test_table",
        "ColumnName": "id",
        "AutoIncrementCurrentValue": 2147483647,
        "MaximumValue": 2147483647,
        "AutoIncrementRatio": 1
      }
    ]
  },
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The request parameters are invalid. 請求參數錯誤
    403 NoPermission You are not authorized to do this action. 沒有許可權執行該操作

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

    變更歷史

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