すべてのプロダクト
Search

このプロダクト

    Data Management:UpdateInstance

    ドキュメントセンター

    Data Management:UpdateInstance

    最終更新日:Mar 21, 2026

    データベースインスタンスの情報を更新し、データベースインスタンスの接続性を確認します。

    操作説明

    `UpdateInstance` 操作を呼び出す前に、`GetInstance` または `ListInstances` 操作を呼び出して、インスタンスに関する完全な情報を取得します。

    今すぐお試しください

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

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID。テナント ID を照会するには、GetUserActiveTenant 操作を呼び出します。

    3***
    InstanceType

    string

    必須

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

    mysql
    InstanceSource

    string

    必須

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

    • PUBLIC_OWN: インターネットにデプロイされた自己管理データベースインスタンス

    • RDS: ApsaraDB RDS インスタンス

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

    • VPC_IDC: 仮想プライベートクラウド (VPC) 経由で接続されたデータセンターにデプロイされた自己管理データベースインスタンス

    ECS_OWN
    EnvType

    string

    必須

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

    • product: 本番環境

    • dev: 開発環境

    • pre: プレリリース環境

    • test: テスト環境

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

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

    • pet: ストレステスト環境

    • stag: ステージング環境

    列挙値:

    • product :

      プロダクト

    • pre :

      pre

    • dev :

      dev

    • test :

      test

    product
    EcsInstanceId

    string

    任意

    データベースインスタンスがデプロイされている ECS インスタンスの ID。

    説明

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

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    任意

    データベースインスタンスが属する VPC の ID。

    説明

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

    vpc-xxx
    EcsRegion

    string

    任意

    データベースインスタンスが存在するリージョンの ID。

    説明

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

    cn-hangzhou
    Host

    string

    必須

    データベースインスタンスへの接続に使用されるホストアドレス。

    192.XXX.0.56
    Port

    integer

    必須

    データベースインスタンスへの接続に使用されるポート。

    3306
    Sid

    string

    任意

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

    説明

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

    XXX
    DatabaseUser

    string

    必須

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

    dbuser
    DatabasePassword

    string

    必須

    データベースへのログインに使用されるパスワード。

    ******
    InstanceAlias

    string

    必須

    データベースインスタンスのエイリアス。DMS でデータベースインスタンスを識別するのに役立つエイリアスを指定します。

    instance_test
    DbaId

    string

    必須

    データベースインスタンスのデータベース管理者 (DBA) ロールを担当するユーザーの ID です。ListUsers 操作または GetInstance 操作を呼び出して、ユーザー ID をクエリできます。

    27****
    SafeRuleId

    string

    必須

    インスタンスのセキュリティルールセット (`GroupName`) の名前。セキュリティルールセットの名前を照会するには、ListStandardGroups または GetInstance 操作を呼び出します。

    3****
    QueryTimeout

    integer

    必須

    データベースインスタンス内のデータクエリのタイムアウト期間。

    60
    ExportTimeout

    integer

    必須

    データベースインスタンスからのデータエクスポートのタイムアウト期間。

    600
    DataLinkName

    string

    任意

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

    説明

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

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

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

    datalink_test
    DdlOnline

    integer

    任意

    データベースインスタンスのロックフリースキーマ変更機能を有効にするかどうかを指定します。有効な値は次のとおりです。

    • 0: ロックフリースキーマ変更機能を無効にします。

    • 1: 最初に MySQL のオンライン DDL を使用します。

    • 2: 最初に DMS のロックフリースキーマ変更機能を使用します。

    0
    UseDsql

    integer

    任意

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

    • 0: クロスデータベースクエリ機能を無効にします。

    • 1: クロスデータベースクエリ機能を有効にします。

    説明

    サポートされているデータベースタイプ: MySQL、SQL Server、PostgreSQL、PolarDB for PostgreSQL (Oracle 互換)、および ApsaraDB for Redis。

    0
    InstanceId

    string

    必須

    データベースインスタンスの ID。インスタンス ID を照会するには、GetInstance 操作を呼び出します。

    126****
    SkipTest

    boolean

    任意

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

    • true: 接続性テストをスキップします。

    • false: 接続性テストをスキップしません。

    false
    EnableSellSitd

    string

    任意

    • Y: 機密データ保護機能を有効にします。

    • N: 機密データ保護機能を無効にします。

    • NULL またはその他: 機密データ保護機能のステータスを更新しません。

    Y
    TemplateId

    integer

    任意

    分類テンプレートの ID。テンプレート ID を照会するには、ListClassificationTemplates 操作を呼び出します。

    3***
    TemplateType

    string

    任意

    分類テンプレートのタイプ。テンプレートタイプを照会するには、ListClassificationTemplates 操作を呼び出します。

    INNER

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID。

    E9BEBF41-4F69-4605-A5D5-A67955173941
    ErrorCode

    string

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

    UnknownError
    ErrorMessage

    string

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

    UnknownError
    Success

    boolean

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

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

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

    false

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "E9BEBF41-4F69-4605-A5D5-A67955173941",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": false
}

    エラーコード

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

    変更履歴

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