全部產品
Search

搜尋本產品

    Data Management：AddInstance

    文件中心

    Data Management：AddInstance

    更新時間：Jul 15, 2026

    呼叫此 API 可以實現將您的資料庫執行個體錄入至 DMS 中，同時，可以為執行個體啟用安全託管能力。

    介面說明

    系統角色為 DBA 或管理員。查看系統角色的操作，請參見查看我的系統角色。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:AddInstance

    create

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Tid

    integer

    否

    租戶 ID。

    說明

    取自 DMS 主控台頁面右上角頭像處懸停顯示的租戶 ID 資訊。

    23****
    InstanceType

    string

    是

    資料庫類型，取值請參見DbType 參數說明。

    MySQL
    InstanceSource

    string

    是

    執行個體來源，取值如下：

    • PUBLIC_OWN：表示公網自建執行個體。

    • RDS：表示 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

    是

    執行個體別名，協助使用者快速區分定位該執行個體。

    Test instance
    DbaId

    integer

    是

    執行個體 DBA 角色的使用者 ID，可呼叫介面 ListUsers 或 GetInstance 取得該參數的值。

    27****
    QueryTimeout

    integer

    是

    查詢逾時時間，單位：s（秒）。

    7200
    ExportTimeout

    integer

    是

    匯出逾時時間，單位：s（秒）。

    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

    否

    輸入跨庫查詢 datalink 名稱。

    說明

    • 如果 UseDsql 取值為 1，此值必填。

    • DBLink 名稱只能使用小寫字母和底線（_）。

    • DBLink 名稱需要在租戶內保持全域唯一性。

    dblink_test
    DdlOnline

    integer

    否

    是否啟用 DMS 結構變更優先，取值如下：

    • 0 ：不使用。

    • 1 ：原生 Online DDL 優先。

    • 2 ：DMS 無鎖表結構變更優先。

    說明

    支援的資料庫類型：RDS MySQL、PolarDB MySQL 引擎、MyBase MySQL、其他來源 MySQL。

    2
    UseDsql

    integer

    否

    是否啟用跨執行個體查詢，取值如下：

    • 0：不啟用。

    • 1：啟用。

    說明

    支援的資料庫類型：MySQL、SQL Server、PostgreSQL、PolarDB O 引擎、Redis。

    1
    SkipTest

    boolean

    否

    執行個體是否忽略測試連通性。取值如下：

    • true：忽略。

    • false：不忽略。

    false
    TemplateId

    integer

    否

    分類分級範本 ID。您可呼叫 ListClassificationTemplates 介面取得該參數的值。

    31***
    TemplateType

    string

    否

    分類分級範本類型。您可呼叫 ListClassificationTemplates 取得該參數的值。

    INNER
    UseSsl

    integer

    否

    選擇是否啟用 SSL 連線，啟用後，DMS 將透過 SSL 連線到資料庫。使用該參數的前提是資料庫已啟用 SSL 連線，目前支援如下選項：

    • 0：預設值（DMS 與資料庫服務自動協商是否啟用）系統將自動識別目標資料庫是否已啟用 SSL 連線，若資料庫已啟用 SSL 連線，則 DMS 將透過 SSL 連線資料庫；若資料庫未啟用 SSL 連線，則透過普通方式進行連線。

    • 1：啟用 SSL 連線。若資料庫未啟用 SSL 連線，則該參數無效。

    • -1：關閉 SSL 連線。

    說明

    • 該設定項目僅在資料庫為 MySQL 或 Redis 時出現。

    • SSL（Secure Sockets Layer）能在傳輸層對網路連線進行加密，提升通訊資料的安全性和完整性，但會增加網路連線回應時間。

    0
    RoleArn

    string

    否

    目標帳號授權角色的 ARN，用於跨租戶錄入。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求的 ID。用於定位日誌，排查問題。

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

    string

    錯誤碼。

    UnknownError
    ErrorMessage

    string

    錯誤訊息。

    UnknownError
    Success

    boolean

    請求是否成功，回傳值如下：

    • true：請求成功。

    • false：請求失敗。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。