すべてのプロダクト
Search

このプロダクト

    Data Management:ModifyInstance

    ドキュメントセンター

    Data Management:ModifyInstance

    最終更新日:Mar 21, 2026

    Data Management (DMS) のデータベースインスタンスに関する基本情報と詳細情報を変更します。基本情報には、インスタンスのホスティングモード、インスタンスアカウントのユーザー名とパスワード、およびインスタンスで有効化されている機能が含まれます。詳細情報には、環境タイプ、DMS 内のインスタンス名、データクエリおよびエクスポートのタイムアウト期間が含まれます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ModifyInstance

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID。インスタンス ID をクエリするには、ListInstances または GetInstance 操作を呼び出します。

    183****
    Tid

    integer

    任意

    テナントの ID。

    説明

    テナント ID を取得するには、DMS コンソールの右上隅にあるプロフィール画像にポインターを合わせます。

    23****

    InstanceType

    string

    任意

    データベースインスタンスのタイプ。このパラメーターの有効な値の詳細については、「DbType parameter」をご参照ください。

    MySQL
    InstanceSource

    string

    任意

    データベースインスタンスのソース。有効な値は次のとおりです。

    • PUBLIC_OWN: インターネット上にデプロイされている自己管理データベースインスタンス。

    • RDS: ApsaraDB RDS インスタンス。

    • ECS_OWN: Elastic Compute Service (ECS) インスタンス上にデプロイされている自己管理データベースインスタンス。

    • VPC_IDC: Virtual Private Cloud (VPC) 経由で接続されたデータセンターにデプロイされている自己管理データベースインスタンス。

    RDS
    NetworkType

    string

    任意

    データベースインスタンスのネットワークタイプ。有効な値は次のとおりです。

    • CLASSIC: クラシックネットワーク。

    • VPC: VPC。

    VPC
    EnvType

    string

    任意

    データベースインスタンスがデプロイされている環境のタイプ。有効な値は次のとおりです。

    • product: 本番環境。

    • dev: 開発環境。

    • pre: プレリリース環境。

    • test: テスト環境。

    • sit: システム統合テスト (SIT) 環境。

    • uat: ユーザー受け入れテスト (UAT) 環境。

    • pet: 負荷テスト環境。

    • stag: ステージング環境。

    dev
    EcsInstanceId

    string

    任意

    ECS インスタンスの ID。

    説明

    InstanceSource が ECS_OWN に設定されている場合、このパラメーターは必須です。

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    任意

    VPC ID。

    説明

    InstanceSource が VPC_IDC に設定されている場合、このパラメーターは必須です。

    vpc-bp10wnlcmor****
    EcsRegion

    string

    任意

    ECS インスタンスが存在するリージョン。

    説明

    InstanceSource が RDS、ECS_OWN、または VPC_IDC に設定されている場合、このパラメーターは必須です。

    cn-hangzhou
    Host

    string

    任意

    データベースインスタンスに接続するために使用されるエンドポイント。

    192.XXX.0.56
    Port

    integer

    任意

    データベースインスタンスに接続するために使用されるポート。

    3306
    Sid

    string

    任意

    データベースインスタンスのシステム ID (SID)。

    説明

    InstanceType が ORACLE に設定されている場合、このパラメーターは必須です。

    testSid
    DatabaseUser

    string

    任意

    データベースインスタンスにログインするために使用されるアカウント。

    testsdb

    DatabasePassword

    string

    任意

    データベースインスタンスにログインするために使用されるアカウントのパスワード。

    test***

    InstanceAlias

    string

    任意

    データベースインスタンスのエイリアス。DMS でデータベースインスタンスを迅速に識別できるように、エイリアスを指定します。

    instance_test
    DbaId

    integer

    任意

    データベース管理者 (DBA) ロールを担うユーザーの ID。このパラメーターの値を取得するには、ListUsers または GetInstance 操作を呼び出します。

    27****
    QueryTimeout

    integer

    任意

    データベースインスタンスからデータをクエリする際のタイムアウト期間。単位: 秒。

    7200
    ExportTimeout

    integer

    任意

    データベースインスタンスからデータをエクスポートする際のタイムアウト期間。単位: 秒。

    86400
    EnableSellTrust

    string

    任意

    データベースインスタンスのセキュリティホスティング機能を有効化するかどうかを指定します。有効な値は次のとおりです。

    • Y: 有効化。

    • N: 無効化。

    Y
    EnableSellStable

    string

    任意

    データベースインスタンスの安定的な変更を有効化するかどうかを指定します。有効な値は次のとおりです。

    • Y: 有効化。

    • N: 無効化。

    N
    EnableSellCommon

    string

    任意

    データベースインスタンスのセキュリティコラボレーションを有効化するかどうかを指定します。有効な値は次のとおりです。

    • Y: 有効化。

    • N: 無効化。

    Y
    SafeRule

    string

    任意

    データベースインスタンスのセキュリティルールセットの名前。セキュリティコラボレーションが有効化されている場合、このパラメーターは必須です。セキュリティルールセットの名前を GroupName から取得するには、ListStandardGroups または GetInstance 操作を呼び出します。

    金融线-生产
    EnableSellSitd

    string

    任意

    機密データ保護を有効化するかどうかを指定します。有効な値は次のとおりです。

    • Y: 有効化。

    • N: 無効化。

    Y
    DataLinkName

    string

    任意

    データベース間クエリ用のデータベースリンクの名前。

    説明

    • UseDsql が 1 に設定されている場合、このプロパティは必須です。

    • 名前には小文字とアンダースコア (_) のみを含めることができます。

    • 名前はテナント内で一意である必要があります。

    dblink_test
    DdlOnline

    integer

    任意

    ロックフリースキーマ変更を有効化するかどうかを指定します。有効な値は次のとおりです。

    • 0: ロックフリースキーマ変更を無効化。

    • 1: MySQL ネイティブオンライン DDL 優先。

    • 2: DMS ネイティブオンライン DDL 優先。

    説明

    サポートされているデータベースには、ApsaraDB RDS for MySQL、PolarDB for MySQL、ApsaraDB MyBase for MySQL、およびサードパーティの MySQL データベースが含まれます。

    2
    UseDsql

    integer

    任意

    データベースインスタンスのインスタンス間クエリを有効化するかどうかを指定します。有効な値は次のとおりです。

    • 0: データベース間クエリを無効化。

    • 1: データベース間クエリを有効化。

    説明

    サポートされているデータベースには、MySQL、SQL Server、PostgreSQL、PolarDB for Oracle、および Redis が含まれます。

    1
    SkipTest

    boolean

    任意

    接続性テストをスキップするかどうかを指定します。有効な値は次のとおりです。

    • true

    • false

    false
    TemplateId

    integer

    任意

    分類およびグレーディングテンプレートの ID。テンプレート ID をクエリするには、ListClassificationTemplates 操作を呼び出します。

    31***
    TemplateType

    string

    任意

    分類およびグレーディングテンプレートのタイプ。テンプレートタイプをクエリするには、ListClassificationTemplates 操作を呼び出します。

    INNER
    UseSsl

    integer

    任意

    Data Management Service (DMS) が SSL 接続を使用してデータベースインスタンスに接続することを許可するかどうかを指定します。SSL 接続を使用する前に、データベースインスタンスで SSL 暗号化機能が有効化されていることを確認してください。有効な値は次のとおりです。

    • 0 (デフォルト): DMS は、データベースインスタンスで自己ネゴシエーションが有効化されているかどうかを自動的にチェックします。DMS は、データベースインスタンスで SSL 暗号化機能が有効化されているかどうかを自動的にチェックします。SSL 暗号化機能が有効化されている場合、DMS は SSL 接続を使用してデータベースインスタンスに接続します。それ以外の場合、DMS は暗号化なしでデータベースインスタンスに接続します。

    • 1: DMS は SSL 接続を使用してデータベースインスタンスに接続します。SSL 暗号化機能がデータベースインスタンスで無効化されている場合、この値は無効です。

    • -1: DMS は SSL 接続を使用してデータベースインスタンスに接続しません。

    説明

    • このパラメーターは、MySQL または Redis データベースインスタンスでのみ利用可能です。

    • SSL は、トランスポート層でネットワーク接続を暗号化し、データ伝送のセキュリティと整合性を向上させます。ただし、SSL はネットワーク接続の応答時間を増加させます。

    0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。この ID を使用してログをクエリし、問題をトラブルシューティングできます。

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    UnknownError
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージ。

    UnknownError
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は次のとおりです。

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

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    エラーコード

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

    変更履歴

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