すべてのプロダクト
Search

このプロダクト

    Data Management:RegisterInstance

    ドキュメントセンター

    Data Management:RegisterInstance

    最終更新日:Mar 21, 2026

    DMS にデータベースインスタンスを登録します。

    操作説明

    前提条件：管理者またはデータベース管理者 (DBA) のロールが必要です。ListUsers または GetUser API を呼び出して RoleIdList を取得できます。

    今すぐお試しください

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

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナント ID。 GetUserActiveTenant 操作を呼び出してこの ID を取得できます。

    3***
    InstanceType

    string

    必須

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

    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：Virtual Private Cloud (VPC)

    VPC
    EnvType

    string

    必須

    環境タイプ。 有効な値：

    • product：本番環境

    • dev：開発環境

    • pre：プレリリース環境

    • test：テスト環境

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

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

    • pet：パフォーマンステスト環境

    • stag：ステージング環境

    product
    EcsInstanceId

    string

    任意

    ECS インスタンスの ID。

    説明

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

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    任意

    VPC の ID。

    説明

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

    vpc-xxxxxxxxxxxxxxxxxxxxx
    EcsRegion

    string

    任意

    インスタンスが配置されているリージョン。

    説明

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

    cn-hangzhou
    Host

    string

    必須

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

    172.XX.XXX.254
    Port

    integer

    必須

    データベースインスタンスの接続ポート。

    3306
    Sid

    string

    任意

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

    説明

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

    XXX
    DatabaseUser

    string

    必須

    データベースアカウントのユーザー名。

    dmstest
    DatabasePassword

    string

    必須

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

    ******
    InstanceAlias

    string

    必須

    インスタンスをすばやく識別するためのエイリアス。

    测试实例
    DbaUid

    integer

    必須

    インスタンスのデータベース管理者 (DBA) ロールを持つユーザーの UID。 ListUsers または GetInstance 操作を呼び出してこの ID を取得できます。

    22275482072787****
    SafeRule

    string

    必須

    インスタンスのセキュリティルールセット (GroupName) の名前。 ListStandardGroups または GetInstance 操作を呼び出してこの値を取得できます。

    测试使用
    QueryTimeout

    integer

    必須

    クエリのタイムアウト期間 (秒単位)。

    60
    ExportTimeout

    integer

    必須

    エクスポートのタイムアウト期間 (秒単位)。

    600
    DataLinkName

    string

    任意

    インスタンス間クエリのデータリンク名。

    説明

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

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

    • データリンク名は、テナント内で一意である必要があります。

    dblink_test
    DdlOnline

    integer

    任意

    ロックフリーのスキーマ変更の戦略。 有効な値：

    • 0：無効。

    • 1：ネイティブのロックフリー操作を優先します。 操作が失敗した場合、実行は Data Management (DMS) にフォールバックします。

    • 2：ロックフリーのスキーマ変更に Data Management (DMS) を使用します。

    説明

    注：サポートされているデータベースタイプ：ApsaraDB RDS for MySQL、PolarDB for MySQL、ApsaraDB for MyBase (MySQL)、およびその他の MySQL 互換データベース。

    2
    UseDsql

    integer

    任意

    インスタンス間クエリを有効にするかどうかを指定します。 有効な値：

    • 0：無効

    • 1：有効

    説明

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

    1
    SkipTest

    boolean

    任意

    接続テストをスキップするかどうかを指定します。 有効な値：

    • true：テストをスキップします。

    • false：テストを実行します。

    true
    EnableSellSitd

    string

    任意

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

    • NULL またはその他の値：機密データ保護を無効にします。

    Y
    TemplateId

    integer

    任意

    機密データ分類テンプレートの ID。 ListClassificationTemplates 操作を呼び出してこの ID を取得できます。

    31***
    TemplateType

    string

    任意

    機密データ分類テンプレートのタイプ。 ListClassificationTemplates 操作を呼び出してこの値を取得できます。

    INNER
    DbaUidByString

    string

    任意

    このパラメーターは DbaUid を置き換え、RAM ロールの UID などの非数値 UID をサポートします。

    22275482072787****
    ResourceGroup

    string

    任意

    リソースグループの ID。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    RequestId

    string

    リクエストの ID。

    F4E2A94B-604F-43FF-93E7-F4EE3DCF412E
    ErrorCode

    string

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

    UnknownError
    ErrorMessage

    string

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

    UnknownError
    Success

    boolean

    リクエストが成功したかどうかを示します。 有効な値：

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

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    エラーコード

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

    変更履歴

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