DescribeSqlLogConfig - - Alibaba Cloud ドキュメントセンター

データベースインスタンスで有効になっている Database Autonomy Service (DAS) Enterprise Edition の構成を照会します。

操作説明

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

Alibaba Cloud SDK または DAS SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。
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:DescribeSqlLogConfig

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	データベースインスタンスの ID。	rm-2ze8g2am97624****

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	レスポンスコード。	200
Data	object	返されるデータ。
ColdEnable	boolean	コールドデータストレージが有効になっているかどうかを示します。有効な値： true false	true
ColdRetention	integer	SQL Explorer と監査データがコールドストレージに保存される日数。	23
ColdStartTime	integer	コールドデータストレージが有効になった時刻。この値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1683712800000
CollectorVersion	string	コレクターのバージョン。有効な値： MYSQL_V0 MYSQL_V1 MYSQL_V2 MYSQL_V3 PG_V1 rdspg_v1 polarpg_v1	MYSQL_V3
HotEnable	boolean	ホットデータストレージが有効になっているかどうかを示します。有効な値： true false	true
HotRetention	integer	SQL Explorer と監査データがホットストレージに保存される日数。	7
HotStartTime	integer	ホットデータストレージが有効になった時刻。この値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1683712800000
LogFilter	string	予約済みパラメーター。	None
RequestEnable	boolean	SQL Explorer 機能が有効になっているかどうかを示します。有効な値： true false	true
RequestStartTime	integer	SQL Explorer 機能が有効になった時刻。この値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1683712800000
RequestStopTime	integer	DAS Enterprise Edition V1 の有効期限が切れた時刻。この値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1715335200000
Retention	integer	SQL Explorer と監査データの合計ストレージ期間。このパラメーターの値は、HotRetention と ColdRetention の値の合計です。単位：日。	30
SqlLogEnable	boolean	DAS Enterprise Edition が有効になっているかどうかを示します。有効な値： true false	true
SqlLogSource	string	予約済みパラメーター。	None
SqlLogState	string	データ移行の状態。有効な値： FINISH：既存データは移行済みです。 RUNNING：既存データを移行中です。 FAILURE：既存データの移行に失敗しました。	FINISH
SqlLogVisibleTime	integer	DAS Enterprise Edition が有効になった時刻。この値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1683712800000
SupportMigration	boolean	予約済みパラメーター。	None
SupportVersion	string	データベースインスタンスをサポートする DAS Enterprise Edition の最新バージョン。有効な値： SQL_LOG_V0：DAS Enterprise Edition V0。 SQL_LOG_V1：DAS Enterprise Edition V1。 SQL_LOG_V2：DAS Enterprise Edition V2。 SQL_LOG_V3：DAS Enterprise Edition V3。 SQL_LOG_NOT_ENABLE：DAS Enterprise Edition は有効になっていません。 SQL_LOG_NOT_SUPPORT：DAS Enterprise Edition はサポートされていません。	SQL_LOG_V3
Version	string	データベースインスタンスで有効になっている DAS Enterprise Edition のバージョン。有効な値： SQL_LOG_V0：DAS Enterprise Edition V0。 SQL_LOG_V1：DAS Enterprise Edition V1。 SQL_LOG_V2：DAS Enterprise Edition V2。 SQL_LOG_V3：DAS Enterprise Edition V3。 SQL_LOG_NOT_ENABLE：DAS Enterprise Edition は有効になっていません。 SQL_LOG_NOT_SUPPORT：DAS Enterprise Edition はサポートされていません。	SQL_LOG_V3
Message	string	返されたメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合は、エラーメッセージが返されます。	Successful
RequestId	string	リクエスト ID。	0A74B755-98B7-59DB-8724-1321B394****
Success	string	リクエストが成功したかどうかを示します。有効な値： true false	true

DAS Enterprise Edition V0 または DAS Enterprise Edition V1 が有効になっているデータベースインスタンスの場合、SQL Explorer と監査データは 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,
    "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.

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

変更履歴

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