すべてのプロダクト
Search
ドキュメントセンター

Database Autonomy Service:GetAutoIncrementUsageStatistic

最終更新日:Mar 13, 2026

自動増分テーブル ID の使用量をクエリします。

操作説明

  • この操作は、ApsaraDB RDS for MySQL インスタンスおよび PolarDB for MySQL クラスターにのみ適用されます。

  • Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。

  • SDK を使用して DAS を呼び出す場合は、リージョンを cn-shanghai に設定する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:GetAutoIncrementUsageStatistic

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

インスタンスの ID。

rm-2ze8g2am97624****

DbNames

string

任意

データベース名。データベースを指定すると、指定されたデータベース内の自動増分テーブル ID の使用量をクエリします。指定しない場合、インスタンス上のすべてのデータベース内の自動増分テーブル ID の使用量をクエリします。

説明

パラメーター値は、['db1','db2'] のような JSON 配列として指定します。複数のデータベース名はコンマ (,) で区切ります。

['db1','db2']

RatioFilter

number

必須

自動増分 ID の使用量しきい値。しきい値を超える使用量のみが返されます。有効な値は、0 から 1 の範囲の 10 進数です。

0.9

RealTime

boolean

必須

リアルタイムデータをクエリするかどうかを指定します。有効な値は次のとおりです。

  • true:過去 10 分間に生成されたデータを除くリアルタイムデータをクエリします。

  • false:過去 2 時間に生成されたデータをクエリします。そのようなデータが存在しない場合は、最新のデータをクエリします。

false

レスポンスフィールド

フィールド

説明

object

Code

integer

返された HTTP ステータスコード。

200

Message

string

返されたメッセージ。

説明

リクエストが成功した場合、Successful が返されます。それ以外の場合、エラーコードなどのエラーメッセージが返されます。

Successful

Data

object

返されたデータ。

Finish

boolean

タスクが完了したかどうかを示します。有効な値は次のとおりです。

  • true

  • false

false

Timestamp

integer

リクエストが行われた時刻。この値は、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から経過したミリ秒数を示す UNIX タイムスタンプです。

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

成功レスポンス

JSONJSON

{
  "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 ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParams The request parameters are invalid.
403 NoPermission You are not authorized to do this action.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。