文档

GetAutoIncrementUsageStatistic - 获取表自增ID使用数据

更新时间:

调用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:GetAutoIncrementUsageStatisticnone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

rm-2ze8g2am97624****
DbNamesstring

数据库名。传入此参数时,查询指定数据库中表自增 ID 使用情况,不传入时查询实例上所有数据库的表自增 ID 使用情况。

说明 数据格式为 JSONArray,例如['db1','db2'],数据库名间用英文逗号(,)分隔。
['db1','db2']
RatioFilterdouble

自增 ID 使用比例过滤值,只返回超过该比例的自增 ID 使用数据。取值为 0~1 的小数。

0.9
RealTimeboolean

是否获取实时数据:

  • true:实时查询实例上数据并计算。最小查询时间粒度为 10 分钟,即有 10 分钟内的数据时,即使传递 true 也不进行实时查询。
  • false:当有近两小时的数据时,返回该数据,否则查询实例上最新数据。
false

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Dataobject

返回的数据。

Finishboolean

任务是否结束:

  • true:任务结束。
  • false:任务未结束。
false
Timestamplong

执行时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1697183353000
TaskStatusstring

任务状态:

  • INIT:初始化。
  • RUNNING:任务执行中。
  • SUCCESS:任务成功。
  • FAIL:任务失败。
INIT
ErrorInfostring

任务失败时的错误信息。

the given database name list invalid, none of the database names in the list exist on the instance
AutoIncrementUsageListarray<object>

自增 ID 使用数据列表。

autoIncrementUsageListobject
DbNamestring

数据库名。

db01
TableNamestring

表名。

test_table
ColumnNamestring

列名。

id
AutoIncrementCurrentValuelong

自增 ID 当前值。

2147483647
MaximumValuelong

该数据类型的自增 ID 支持的最大值。

2147483647
AutoIncrementRatiodouble

自增 ID 使用比例。

1
RequestIdstring

请求 ID。

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

请求是否执行成功:

  • 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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

  • 调用接口时,当返回数据中 Finish 不为 true 时,需要继续调用。当 Finish 为 true 且 TaskStatus 为 SUCCESS 时,可以查看具体的自增 ID 使用数据。