すべてのプロダクト
Search

このプロダクト

    Data Management:AddInstance

    ドキュメントセンター

    Data Management:AddInstance

    最終更新日:Jul 22, 2026

    データ管理サービス (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。

    説明

    DMS コンソールの右上隅にあるプロファイルアイコンにカーソルを合わせると、テナント ID を確認できます。

    23****
    InstanceType

    string

    必須

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

    MySQL。
    InstanceSource

    string

    必須

    ホストインスタンスのソース。有効な値:

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

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

    • ECS_OWN: ECS インスタンス上の自己管理型インスタンス。

    • VPC_IDC: VPC 接続された IDC 内の自己管理型インスタンス。

    • 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

    任意

    インスタンスの SID。

    説明

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

    testSid。
    DatabaseUser

    string

    任意

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

    testsdb。
    DatabasePassword

    string

    任意

    データベースパスワード。

    test***
    InstanceAlias

    string

    必須

    インスタンスのエイリアス。インスタンスをすばやく識別するのに役立ちます。

    テストインスタンス。
    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 操作を呼び出します。

    Finance-Production.
    EnableSellSitd

    string

    任意

    インスタンスの機密データ保護特徴を有効にするかどうかを指定します。有効な値:

    • Y: 有効にします。

    • N: 有効にしません。

    Y
    DataLinkName

    string

    任意

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

    説明

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

    • DBLink 名には、小文字とアンダースコア (_) のみを使用できます。

    • DBLink 名は、テナント内でグローバルに一意である必要があります。

    dblink_test。
    DdlOnline

    integer

    任意

    DMS 構造変更の優先度を指定します。有効な値:

    • 0: 使用しません。

    • 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 PostgreSQL (Oracle 互換)、および Redis。

    1
    SkipTest

    boolean

    任意

    インスタンスの接続性テストをスキップするかどうかを指定します。有効な値:

    • true: スキップします。

    • false: スキップしません。

    false。
    TemplateId

    integer

    任意

    データ分類テンプレートの ID。この値を取得するには、 ListClassificationTemplates 操作を呼び出します。

    31***
    TemplateType

    string

    任意

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

    INNER。
    UseSsl

    integer

    任意

    SSL 接続を有効にするかどうかを指定します。SSL を有効にすると、DMS は SSL 経由でデータベースに接続します。このパラメーターを使用する前に、データベース側で SSL が有効になっている必要があります。有効な値:

    • 0: デフォルト値 (DMS とデータベースサービスが SSL を有効にするかどうかを自動的にネゴシエーションします)。システムは、対象のデータベースで SSL が有効になっているかどうかを自動的に識別します。SSL が有効になっている場合、DMS は SSL 経由でデータベースに接続します。それ以外の場合、DMS は通常のメソッドで接続します。

    • 1: SSL 接続を有効にします。データベースで SSL が有効になっていない場合、このパラメーターは効果がありません。

    • -1: SSL 接続を無効にします。

    説明

    • この設定項目は、データベースタイプが MySQL または Redis の場合にのみ使用できます。

    • SSL (Secure Sockets Layer) はトランスポートレイヤーでネットワーク接続数を暗号化し、通信データのセキュリティと整合性を向上させますが、ネットワーク接続の応答時間が増加します。

    0
    RoleArn

    string

    任意

    クロステナント登録に使用される、ターゲットアカウント内の認可済みロールの Amazon リソースネーム (ARN)。

    acs:ram::1760865*********:role/dms-role-arn
    LoginType

    integer

    任意

    • 0: ユーザー名とパスワードによるログイン。

    • 1: パスワードのみ (Redis)。

    • 2: パスワードなしログイン (Redis)。

    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
}

    エラーコード

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

    変更履歴

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