ModifySqlLogConfig 呼び出しによる DAS Enterprise Edition の有効化と設定 - DAS

ModifySqlLogConfig 操作は、データベースインスタンスに対して DAS Enterprise Edition を有効化または設定するために使用します。

操作説明

この操作を呼び出す前に、次の要件が満たされていることを確認してください：

最新バージョンの Alibaba Cloud SDK または DAS SDK を使用してください。
SDK を使用して DAS サービスを呼び出す場合、リージョンを `cn-shanghai` に設定してください。
この操作では、デフォルトでサポートされている最新バージョンが有効になります。DAS Enterprise Edition の各バージョンでサポートされているデータベースとリージョンの詳細については、「DAS のエディションとサポートされる機能」をご参照ください。

今すぐお試しください

この 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:ModifySqlLogConfig

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	データベースインスタンス ID。	rr-2ze770smbq3tp****
Enable	boolean	任意	DAS Enterprise Edition を有効にするかどうか： true：はい。 false：いいえ。説明 Enterprise Edition を有効にする際にこのパラメーターを設定します。デフォルトでは、サポートされている最新バージョンが有効になります。	true
RequestEnable	boolean	任意	SQL Explorer を有効にするかどうか。 true：はい。 false：いいえ。説明このパラメーターは、Enterprise Edition V3 を有効にする場合にのみ設定します。	true
Retention	integer	任意	合計保存期間 (日数)。有効な値： 7 30 180 365 説明 DAS Enterprise Edition V3 を有効にする場合、このパラメーターの値は 30 以上である必要があります。	30
HotRetention	integer	任意	ホットストレージの保存期間 (日数)。有効な値は 1 から 7 までの整数です。説明このパラメーターは、Enterprise Edition V3 を有効にする場合にのみ設定します。	1
Filters	array<object>	任意	予約済みのパラメーターです。
	object	任意	予約済みのパラメーターです。
Key	string	任意	予約済みのパラメーターです。	None
Value	string	任意	予約済みのパラメーターです。	None
EnableAudit	boolean	任意	セキュリティ監査を有効にするかどうか。	true

DAS Enterprise Edition には、V0、V1、V2、V3 の 4 つのバージョンがあります。デフォルトでは、サポートされている最新バージョンが有効になります。

DAS Enterprise Edition V0 のみをサポートするデータベースインスタンスの場合は、Enable および Retention パラメーターのみを指定します。
DAS Enterprise Edition V1 をサポートするデータベースインスタンスの場合は、Enable および Retention パラメーターのみを指定します。システムは自動的に SQL Explorer を有効にします (つまり、RequestEnable はデフォルトで true になります)。
DAS Enterprise Edition V2 をサポートするデータベースインスタンスの場合は、Enable および Retention パラメーターのみを指定します。システムは自動的に SQL Explorer を有効にします (つまり、RequestEnable はデフォルトで true になります)。ホットデータの保存期間 (HotRetention) は 7 日間に固定され、コールドデータの保存期間は Retention - 7 日間です。

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返されるステータスコード。	200
Message	string	応答メッセージ。説明リクエストが成功した場合、このパラメーターは Successful を返します。リクエストが失敗した場合は、エラーコードなどのエラーメッセージを返します。	Successful
RequestId	string	リクエスト ID。	03C88D8E-1541-518E-8BFF-BEC6589B6334
Success	string	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	false
Data	object	返されたデータ。
SqlLogVisibleTime	integer	DAS Enterprise Edition が有効になった時刻。この値はミリ秒単位の UNIX タイムスタンプです。	1683712800000
RequestStopTime	integer	DAS Enterprise Edition V1 の有効期限。この値はミリ秒単位の UNIX タイムスタンプです。	1715335200000
CollectorVersion	string	データベースコレクターのバージョン。 MYSQL_V0：MySQL V0。 MYSQL_V1：MySQL V1。 MYSQL_V2：MySQL V2。 MYSQL_V3：MySQL V3。 PG_V1：PostgreSQL V1。 rdspg_v1：RDS for PostgreSQL V1。 polarpg_v1：PolarDB for PostgreSQL V1。	MYSQL_V3
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
ColdRetention	integer	コールドデータの保存期間 (日数)。この値は `Retention - HotRetention` として計算されます。	23
SqlLogEnable	boolean	DAS Enterprise Edition が有効になっているかどうかを示します。有効な値： true：はい。 false：いいえ。	true
Retention	integer	合計データ保存期間 (日数)。	30
HotRetention	integer	ホットデータの保存期間 (日数)。	7
RequestEnable	boolean	SQL Explorer が有効になっているかどうかを示します。有効な値： true：はい。 false：いいえ。	false
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
RequestStartTime	integer	SQL Explorer が有効になった時刻。この値はミリ秒単位の UNIX タイムスタンプです。	1683712800000
HotEnable	boolean	ホットデータストレージが有効になっているかどうかを示します。有効な値： true：はい。 false：いいえ。	true
HotStartTime	integer	ホットデータストレージが有効になった時刻。この値はミリ秒単位の UNIX タイムスタンプです。	1683712800000
ColdEnable	boolean	コールドデータストレージが有効になっているかどうかを示します。有効な値： true：はい。 false：いいえ。	true
ColdStartTime	integer	コールドデータストレージが有効になった時刻。この値はミリ秒単位の UNIX タイムスタンプです。	1683712800000
SqlLogState	string	既存データの移行ステータス。有効な値： FINISH：既存データの移行は完了しました。 RUNNING：既存データの移行は進行中です。 FAILURE：既存データの移行に失敗しました。	FINISH
LogFilter	string	予約済みのパラメーターです。	None
SqlLogSource	string

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "03C88D8E-1541-518E-8BFF-BEC6589B6334",
  "Success": "false",
  "Data": {
    "SqlLogVisibleTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "CollectorVersion": "MYSQL_V3",
    "SupportVersion": "SQL_LOG_V3",
    "ColdRetention": 23,
    "SqlLogEnable": true,
    "Retention": 30,
    "HotRetention": 7,
    "RequestEnable": false,
    "Version": "SQL_LOG_V3",
    "RequestStartTime": 1683712800000,
    "HotEnable": true,
    "HotStartTime": 1683712800000,
    "ColdEnable": true,
    "ColdStartTime": 1683712800000,
    "SqlLogState": "FINISH",
    "LogFilter": "None",
    "SqlLogSource": ""
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

変更履歴

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