全部產品
Search

搜尋本產品

    Data Management：UpdateInstance - 更新執行個體資訊（舊）

    文件中心

    Data Management：UpdateInstance - 更新執行個體資訊（舊）

    更新時間：Mar 21, 2026

    更新執行個體資訊，同時檢查該執行個體連通性。

    介面說明

    調用 UpdateInstance 更新執行個體資訊前，請先通過調用介面 GetInstance 或 ListInstances 擷取執行個體的完整資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:UpdateInstance

    update

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Tid

    integer

    否

    租戶 ID，可通過調用介面 GetUserActiveTenant 擷取該參數的值。

    3***
    InstanceType

    string

    是

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

    mysql
    InstanceSource

    string

    是

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

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

    • RDS：代表 RDS 執行個體

    • ECS_OWN：代表 ECS 自建執行個體

    • VPC_IDC：代表 VPC IDC 自建執行個體

    ECS_OWN
    EnvType

    string

    是

    環境類型，取值如下：

    • product：生產環境

    • dev：開發環境

    • pre：預發環境

    • test：測試環境

    • sit：SIT 環境

    • uat：UAT 環境

    • pet：壓測環境

    • stag：STAG 環境

    枚舉值：

    • product :

      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

    否

    執行個體所在地區。

    說明

    如果 InstanceSource 取值為 RDS、ECS_OWN 或 VPC_IDC，此值必填。

    cn-hangzhou
    Host

    string

    是

    執行個體串連地址。

    192.XXX.0.56
    Port

    integer

    是

    執行個體訪問連接埠。

    3306
    Sid

    string

    否

    執行個體 Sid。

    說明

    如果 InstanceType 為 ORACLE，此項必填。

    XXX
    DatabaseUser

    string

    是

    資料庫帳號。

    dbuser
    DatabasePassword

    string

    是

    資料庫訪問密碼。

    ******
    InstanceAlias

    string

    是

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

    instance_test
    DbaId

    string

    是

    執行個體 DBA 角色的使用者識別碼，可通過調用介面 ListUsers 或 GetInstance 擷取該參數的值。

    27****
    SafeRuleId

    string

    是

    執行個體的安全規則集（GroupName），可通過調用介面 ListStandardGroups 或 GetInstance 擷取該參數的值。

    3****
    QueryTimeout

    integer

    是

    執行個體查詢逾時時間。

    60
    ExportTimeout

    integer

    是

    執行個體匯出逾時時間。

    600
    DataLinkName

    string

    否

    輸入跨庫查詢 datalink 名稱。

    說明

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

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

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

    datalink_test
    DdlOnline

    integer

    否

    執行個體是否開啟無鎖結構變更，取值如下：

    • 0 ：不使用

    • 1 ：原生無鎖優先，失敗轉 DMS 執行

    • 2 ：DMS 無鎖變更執行

    0
    UseDsql

    integer

    否

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

    • 0：不開啟

    • 1：開啟

    說明

    支援的資料庫類型：MySQL、SQL Server、PostgreSQL、PolarDB PostgreSQL 版（相容 Oracle）、Redis。

    0
    InstanceId

    string

    是

    執行個體 ID，可通過調用介面 GetInstance 擷取該參數的值。

    126****
    SkipTest

    boolean

    否

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

    • true：忽略

    • false：不忽略

    false
    EnableSellSitd

    string

    否

    • Y：開啟Sensitive Data Discovery and Protection

    • N：關閉Sensitive Data Discovery and Protection

    • NULL 或其它：不更新Sensitive Data Discovery and Protection的狀態，即保持原始的開啟或關閉狀態。

    Y
    TemplateId

    integer

    否

    更新分類分級模板 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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

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

    變更歷史

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