すべてのプロダクト
Search

このプロダクト

    Data Management:AddInstance

    ドキュメントセンター

    Data Management:AddInstance

    最終更新日:Jan 23, 2026

    この操作は、データベースインスタンスを Data Management (DMS) に追加し、インスタンスのセキュリティホスティングを有効にするために使用します。

    操作説明

    データベース管理者 (DBA) または管理者のロールが必要です。システムロールの表示方法の詳細については、「システムロールの表示」をご参照ください。

    今すぐお試しください

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

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナント ID です。

    説明

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

    23****
    InstanceType

    string

    必須

    データベースタイプです。詳細については、「DbType パラメーター」をご参照ください。

    MySQL
    InstanceSource

    string

    必須

    インスタンスのソースです。有効な値：

    • PUBLIC_OWN：インターネット経由で接続される自己管理インスタンス。

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

    • ECS_OWN：Elastic Compute Service (ECS) インスタンスでホストされている自己管理データベース。

    • VPC_IDC：Virtual Private Cloud (VPC) を介して Alibaba Cloud に接続されているデータセンター内の自己管理データベース。

    • GATEWAY：データベースゲートウェイを介して接続されるデータベースインスタンス。

    RDS
    NetworkType

    string

    必須

    ネットワークタイプです。有効な値：

    • CLASSIC：クラシックネットワーク

    • VPC：VPC

    VPC
    EnvType

    string

    必須

    環境タイプです。有効な値：

    • product：本番環境

    • dev：開発環境

    • pre：ステージング環境

    • test：テスト環境

    • sit：SIT 環境

    • uat：UAT 環境

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

    • stag：STAG 環境

    product
    EcsInstanceId

    string

    任意

    インスタンス ID です。たとえば、インスタンスがデータベースゲートウェイインスタンスの場合は、ゲートウェイ ID を入力します。

    説明

    InstanceSource を ECS_OWN または GATEWAY に設定した場合、このパラメーターは必須です。

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    任意

    VPC の ID です。

    説明

    InstanceSource を VPC_IDC に設定した場合、このパラメーターは必須です。

    vpc-2zef4o1hu7ljd****
    EcsRegion

    string

    任意

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

    説明

    InstanceSource を RDS、ECS_OWN、GATEWAY、または VPC_IDC に設定した場合、このパラメーターは必須です。

    cn-hangzhou
    Host

    string

    必須

    データベースエンドポイントです。

    rm-bp1g3tf90******.sqlserver.rds.aliyuncs.com
    Port

    integer

    必須

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

    3306
    Sid

    string

    任意

    インスタンスのシステム ID (SID) です。

    説明

    InstanceType を ORACLE に設定した場合、このパラメーターは必須です。

    testSid
    DatabaseUser

    string

    必須

    データベースアカウントです。

    testsdb
    DatabasePassword

    string

    必須

    データベースアカウントのパスワードです。

    test***
    InstanceAlias

    string

    必須

    インスタンスのエイリアスです。エイリアスはインスタンスを識別するのに役立ちます。

    测试实例
    DbaId

    integer

    必須

    インスタンスの DBA ロールを持つユーザーの ID です。ユーザー 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

    任意

    クロスデータベースクエリ DBLink の名前です。

    説明

    • UseDsql を 1 に設定した場合、このパラメーターは必須です。

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

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

    dblink_test
    DdlOnline

    integer

    任意

    スキーマ進化のために DMS を優先するかどうかを指定します。有効な値：

    • 0：DMS を優先しません。

    • 1：ネイティブオンライン DDL を優先します。

    • 2：DMS ロックフリーのスキーマ進化を優先します。

    説明

    サポートされているデータベースタイプ：ApsaraDB RDS for MySQL、PolarDB for MySQL、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

    任意

    SSL 暗号化を有効にするかどうかを指定します。この機能を有効にすると、DMS は SSL 暗号化接続を介してデータベースに接続します。このパラメーターは、データベースが SSL 暗号化をサポートしている場合にのみ有効です。有効な値：

    • 0：デフォルト値。DMS はデータベースと自動的にネゴシエートして、SSL 接続を使用するかどうかを決定します。データベースが SSL をサポートしている場合、DMS は SSL 暗号化接続を介してデータベースに接続します。データベースが SSL をサポートしていない場合、DMS は通常の接続を介してデータベースに接続します。

    • 1：SSL 暗号化を有効にします。この値は、データベースが SSL をサポートしていない場合は無効です。

    • -1：SSL 暗号化を無効にします。

    説明

    • このパラメーターは、MySQL および Redis データベースでのみ使用できます。

    • Secure Sockets Layer (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
}

    エラーコード

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

    変更履歴

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