すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:DescribeSqlLogConfig

    ドキュメントセンター

    Database Autonomy Service:DescribeSqlLogConfig

    最終更新日:Jul 13, 2026

    データベースインスタンスの DAS Enterprise Edition 構成を照会します。

    操作説明

    開始する前に:

    • Alibaba Cloud または DAS 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:DescribeSqlLogConfig

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    データベースインスタンスの ID。

    rm-2ze8g2am97624****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    返される状態コード。

    200
    Data

    object

    返されるデータ。

    ColdEnable

    boolean

    コールドデータストレージが有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    true
    ColdRetention

    integer

    コールドデータストレージの保存期間。単位: 日。

    23
    ColdStartTime

    integer

    コールドデータストレージの開始時刻。値は UNIX タイムスタンプです。単位: ミリ秒。

    1683712800000
    CollectorVersion

    string

    コレクターのバージョン。有効な値:

    • MYSQL_V0: MySQL V0。

    • MYSQL_V1: MySQL V1。

    • MYSQL_V2: MySQL V2。

    • MYSQL_V3: MySQL V3。

    • PG_V1: PostgreSQL V1。

    • rdspg_v1: ApsaraDB RDS for PostgreSQL V1。

    • polarpg_v1: PolarDB for PostgreSQL V1。

    MYSQL_V3
    HotEnable

    boolean

    ホットデータストレージが有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    true
    HotRetention

    integer

    ホットデータストレージの保存期間。単位: 日。

    7
    HotStartTime

    integer

    ホットデータストレージの開始時刻。値は UNIX タイムスタンプです。単位: ミリ秒。

    1683712800000
    LogFilter

    string

    予約済みパラメーター。

    None
    RequestEnable

    boolean

    SQL Explorer が有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    true
    RequestStartTime

    integer

    SQL Explorer が有効化された時刻。値は UNIX タイムスタンプです。単位: ミリ秒。

    1683712800000
    RequestStopTime

    integer

    DAS Enterprise Edition V1 の有効期限時刻。値は UNIX タイムスタンプです。単位: ミリ秒。

    1715335200000
    Retention

    integer

    データストレージの合計保存期間。HotRetention と ColdRetention の合計です。単位: 日。

    30
    SqlLogEnable

    boolean

    DAS Enterprise Edition が有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    true
    Enable

    boolean

    SqlLogSource

    string

    予約済みパラメーター。

    None
    SqlLogState

    string

    データ移行のステータス。有効な値:

    • FINISH: 既存データの移行が完了しました。

    • RUNNING: 既存データの移行が進行中です。

    • FAILURE: 既存データの移行は失敗しました。

    FINISH
    SqlLogVisibleTime

    integer

    DAS Enterprise Edition が有効化された時刻。値は UNIX タイムスタンプです。単位: ミリ秒。

    1683712800000
    SupportMigration

    boolean

    予約済みパラメーター。

    None
    SupportVersion

    string

    インスタンスでサポートされている最新の DAS Enterprise Edition バージョン。有効な値:

    • SQL_LOG_V0: Enterprise Edition V0。

    • SQL_LOG_V1: Enterprise Edition V1。

    • SQL_LOG_V2: Enterprise Edition V2。

    • SQL_LOG_V3: Enterprise Edition V3。

    • SQL_LOG_NOT_ENABLE: Enterprise Edition は有効ではありません。

    • SQL_LOG_NOT_SUPPORT: Enterprise Edition はサポートされていません。

    SQL_LOG_V3
    Version

    string

    現在有効になっている DAS Enterprise Edition のバージョン。有効な値:

    • SQL_LOG_V0: Enterprise Edition V0。

    • SQL_LOG_V1: Enterprise Edition V1。

    • SQL_LOG_V2: Enterprise Edition V2。

    • SQL_LOG_V3: Enterprise Edition V3。

    • SQL_LOG_NOT_ENABLE: Enterprise Edition は有効ではありません。

    • SQL_LOG_NOT_SUPPORT: Enterprise Edition はサポートされていません。

    SQL_LOG_V3
    Message

    string

    返されるメッセージ。

    説明

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

    Successful
    RequestId

    string

    リクエスト ID。

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

    string

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

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    true

    SQL_LOG_V0 (Enterprise Edition V0) および SQL_LOG_V1 (Enterprise Edition V1) の場合、データは CStore に保存され、ホットストレージとみなされます。これらのエディションが有効になっているデータベースインスタンスの場合、クエリは SqlLogEnable = HotEnable = true, Retention = HotRetention, ColdEnable = false, ColdRetention = 0 を返します。

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Data": {
    "ColdEnable": true,
    "ColdRetention": 23,
    "ColdStartTime": 1683712800000,
    "CollectorVersion": "MYSQL_V3",
    "HotEnable": true,
    "HotRetention": 7,
    "HotStartTime": 1683712800000,
    "LogFilter": "None",
    "RequestEnable": true,
    "RequestStartTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "Retention": 30,
    "SqlLogEnable": true,
    "Enable": false,
    "SqlLogSource": "None",
    "SqlLogState": "FINISH",
    "SqlLogVisibleTime": 1683712800000,
    "SupportMigration": true,
    "SupportVersion": "SQL_LOG_V3",
    "Version": "SQL_LOG_V3"
  },
  "Message": "Successful",
  "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. この操作を実行する権限がありません。
    404 InstanceNotFound The specified instance does not exist. インスタンスが存在しません。

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

    変更履歴

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