すべてのプロダクト
Search

このプロダクト

    :GetInstanceInspections

    ドキュメントセンター

    :GetInstanceInspections

    最終更新日:Dec 19, 2025

    巡回とスコアリング機能を使用してデータベースインスタンスで実行された巡回の結果を照会します。

    操作説明

    Database Autonomy Service (DAS) は、巡回とスコアリング機能を提供します。この機能を使用すると、ご利用のインスタンスの健全性ステータスを定期的に巡回し、スコアリングできます。これにより、データベースのステータスに関する情報を取得できます。詳細については、「巡回とスコアリング」をご参照ください。

    この操作を呼び出す前に、次の項目にご注意ください。

    • この操作は、ApsaraDB RDS for MySQL データベース、Elastic Compute Service (ECS) インスタンスでホストされている自己管理 MySQL データベース、データセンター内の自己管理 MySQL データベース、ApsaraDB for Redis データベース、および PolarDB for MySQL データベースにのみ適用されます。

    • Alibaba Cloud SDK を使用する場合、aliyun-sdk-core のバージョンが V4.3.3 以降であることを確認してください。最新バージョンを使用することを推奨します。

    • DAS SDK のバージョンは V1.0.3 以降である必要があります。

    • SDK を使用して DAS の操作を呼び出す場合、リージョン ID を `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:GetInstanceInspections

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Engine

    string

    必須

    データベースエンジン。有効値：

    • MySQL

    • Redis

    • PolarDBMySQL

    MySQL
    StartTime

    string

    必須

    クエリする時間範囲の開始時刻。このパラメーターを、協定世界時 (UTC) の 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプに設定します。

    1655416825000
    EndTime

    string

    必須

    クエリする時間範囲の終了時刻。このパラメーターを、協定世界時 (UTC) の 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプに設定します。

    説明

    終了時刻は開始時刻より後である必要があります。

    1655427625000
    PageNo

    string

    必須

    ページ番号。値は正の整数である必要があります。デフォルト値：1。

    1
    PageSize

    string

    必須

    1 ページあたりのエントリ数。デフォルト値：10。

    10
    InstanceArea

    string

    必須

    データベースがデプロイされているインスタンスのタイプ。有効値：

    • RDS：Alibaba Cloud データベースインスタンス。

    • ECS：自己管理データベースがデプロイされている ECS インスタンス。

    • IDC：Alibaba Cloud にデプロイされていない自己管理データベースインスタンス。

    説明

    値 IDC は、インスタンスがデータセンターにデプロイされていることを示します。

    RDS
    SearchMap

    string

    任意

    フィルター条件。次のいずれかのフォーマットで指定できます：

    • 単一インスタンスの ID を `{"InstanceId":"Instance ID"}` のフォーマットで指定します。

    • 複数のインスタンスの ID を `{"InstanceIds":["Instance ID1","Instance ID2"]}` のフォーマットで指定します。インスタンス ID はコンマ (,) で区切ります。

    • インスタンスが存在するリージョンを `{"region":"Region of the instance"}` のフォーマットで指定します。

    {"InstanceId":"rm-bp10usoc1erj7****"}
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-aek2eil6npi****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    返されたメッセージ。

    説明

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

    Successful
    RequestId

    string

    リクエスト ID。

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

    object

    詳細。

    List

    array<object>

    詳細情報。

    array<object>

    EndTime

    integer

    巡回とスコアリングタスクの終了時刻。値は、協定世界時 (UTC) の 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。

    説明

    終了時刻は開始時刻より後である必要があります。

    1608888296001
    StartTime

    integer

    巡回とスコアリングタスクの開始時刻。この値は、協定世界時 (UTC) の 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。

    1608888296000
    Data

    object

    返されたデータ。

    "data": { "hasDeadLock": false, "exceptionTableMap": {}, "bigTransactionCount": 0, "cpu": 4, "isRds": true, "rdsEnable": true, "enable": false, "activeSessions": [], "bigTransactionList": [], "bigSessionList": [ { "blockDuration": 0, "active": false, "Time": 0, "db": "" },
    Instance

    object

    インスタンスに関する情報。

    VpcId

    string

    インスタンスがデプロイされている Virtual Private Cloud (VPC) の ID。

    vpc-bp1knt7m55z9exoo7****
    Uuid

    string

    インスタンスの一意の識別子。

    hdm_3063db6792965c080a4bcb6e6304****
    InstanceArea

    string

    データベースがデプロイされているインスタンスのタイプ。有効値：

    • RDS：Alibaba Cloud データベースインスタンス。

    • ECS：自己管理データベースがデプロイされている ECS インスタンス。

    • IDC：Alibaba Cloud にデプロイされていない自己管理データベースインスタンス。

    説明

    値 IDC は、インスタンスがデータセンターにデプロイされていることを示します。

    RDS
    InstanceClass

    string

    インスタンスタイプ。

    rds.mysql.s2.xlarge
    Region

    string

    インスタンスのリージョン ID。

    cn-hangzhou
    AccountId

    string

    アカウント ID。Alibaba Cloud マネジメントコンソールでプロファイルにポインターを合わせると、ログインアカウントの ID を表示できます。

    108398049688****
    NetworkType

    string

    インスタンスのネットワークタイプ。

    VPC
    Engine

    string

    データベースエンジン。有効値：

    • MySQL

    • Redis

    • PolarDBMySQL

    MySQL
    InstanceId

    string

    インスタンス ID。

    rm-bp10usoc1erj7****
    NodeId

    string

    インスタンス上のノードの ID。

    rm-bp10usoc1erj7****
    EngineVersion

    string

    データベースエンジンのバージョン番号。

    8.0
    InstanceAlias

    string

    インスタンス名。

    test-01
    Cpu

    string

    インスタンスの CPU 仕様。たとえば、値 8 が返された場合、インスタンスには 8 つの CPU コアがあります。

    8
    Memory

    integer

    インスタンスにデプロイされているデータベースのメモリ容量。単位：MB。

    32768
    Storage

    integer

    インスタンスのストレージ容量。単位：GB。

    150
    Category

    string

    インスタンスの接続モード。有効値：

    • standard：標準モード。

    • safe：データベースプロキシモード。

    standard
    ScoreMap

    object

    インスタンスで減点されたスコア。

    GmtCreate

    integer

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

    1603247192000
    Score

    integer

    インスタンスの巡回スコア。

    100
    AutoFunction

    object

    自律サービスが有効になっているかどうかを示します。

    EventSubscription

    integer

    イベントサブスクリプション機能が有効になっているかどうかを示します。有効値：

    • 0：無効。

    • 1：有効。

    • 2：サポートされていません。

    0
    AutoIndex

    integer

    インデックスの自動作成および削除機能が有効になっているかどうかを示します。有効値：

    • 0：無効。

    • 1：有効。

    • 2：サポートされていません。

    2
    AutoLimitedSql

    integer

    自動スロットリング機能が有効になっているかどうかを示します。有効値：

    • 0：無効。

    • 1：有効。

    • 2：サポートされていません。

    2
    AutoResourceOptimize

    integer

    自動フラグメントリサイクル機能が有効になっているかどうかを示します。有効値：

    • 0：無効。

    • 1：有効。

    • 2：サポートされていません。

    0
    AutoScale

    integer

    自動スケーリング機能が有効になっているかどうかを示します。有効値：

    • 0：無効。

    • 1：有効。

    • 2：サポートされていません。

    0
    EnableDasPro

    integer

    DAS Enterprise Edition が有効になっているかどうかを示します。有効値：

    • 0：無効。

    • 1：有効。

    • 2：サポートされていません。

    0
    State

    integer

    巡回とスコアリングタスクの状態。有効値：

    • 0：実行待機中。

    • 1：進行中。

    • 2：完了。

    2
    TaskType

    integer

    巡回とスコアリングタスクが開始されたモード。有効値：

    • 0：自動モード。

    • 1：手動モード。

    0
    PageNo

    integer

    ページ番号。返される値は正の整数です。デフォルト値：1。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。デフォルト値：10。

    10
    Total

    integer

    返されたエントリの総数。

    4
    Code

    string

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

    200
    Success

    string

    リクエストが成功したかどうかを示します。有効値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "List": [
      {
        "EndTime": 1608888296001,
        "StartTime": 1608888296000,
        "Data": {
          "test": "test",
          "test2": 1
        },
        "Instance": {
          "VpcId": "vpc-bp1knt7m55z9exoo7****",
          "Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
          "InstanceArea": "RDS",
          "InstanceClass": "rds.mysql.s2.xlarge",
          "Region": "cn-hangzhou",
          "AccountId": "108398049688****",
          "NetworkType": "VPC",
          "Engine": "MySQL",
          "InstanceId": "rm-bp10usoc1erj7****",
          "NodeId": "rm-bp10usoc1erj7****",
          "EngineVersion": "8.0",
          "InstanceAlias": "test-01",
          "Cpu": "8",
          "Memory": 32768,
          "Storage": 150,
          "Category": "standard"
        },
        "ScoreMap": {
          "test": "test",
          "test2": 1
        },
        "GmtCreate": 1603247192000,
        "Score": 100,
        "AutoFunction": {
          "EventSubscription": 0,
          "AutoIndex": 2,
          "AutoLimitedSql": 2,
          "AutoResourceOptimize": 0,
          "AutoScale": 0
        },
        "EnableDasPro": 0,
        "State": 2,
        "TaskType": 0
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Total": 4
  },
  "Code": "200",
  "Success": "true"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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