全部產品
Search

搜尋本產品

    ：AddHDMInstance - 接入資料庫執行個體

    文件中心

    ：AddHDMInstance - 接入資料庫執行個體

    更新時間：Dec 19, 2025

    調用AddHDMInstance介面，將資料庫執行個體接入DAS。

    介面說明

    使用該介面需滿足以下前提條件：

    • 使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。

    • 在使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hdm:AddHDMInstance

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    __context

    string

    否

    備用參數。

    None
    InstanceArea

    string

    是

    執行個體所屬的資料庫產品，取值：

    • RDS：雲執行個體。

    • ECS：ECS 自建執行個體。

    • IDC：非公用雲端自建執行個體。

    說明

    IDC 為使用者資料中心。

    ECS
    InstanceId

    string

    否

    執行個體 ID。

    rm-2ze1jdv45i7l6****
    Ip

    string

    否

    待接入執行個體的內網串連地址。

    rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com
    Port

    string

    否

    執行個體的內網串連連接埠。

    3306
    Engine

    string

    否

    資料庫引擎，取值：

    • MySQL

    • PostgreSQL

    • SQLServer

    • PolarDBMySQL

    • PolarDBPostgreSQL

    • Redis

    • MongoDB

    • PolarDBOracle

    • PolarDBX

    MySQL
    Username

    string

    否

    使用者名稱。

    test****
    Password

    string

    否

    使用者名稱的密碼。

    122****
    InstanceAlias

    string

    否

    執行個體名稱。

    yuecq--test****
    NetworkType

    string

    否

    執行個體的網路類型。

    VPC
    VpcId

    string

    否

    VPC ID。

    vpc-m5e666n89m2bx8jar****
    Region

    string

    否

    執行個體所屬的地區。

    cn-hangzhou
    FlushAccount

    string

    否

    備用參數。

    None

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    RequestId

    string

    請求 ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Synchro

    string

    備用參數。

    None
    Data

    object

    詳細資料列表，包括資訊總數、錯誤碼等。

    VpcId

    string

    VPC ID。

    vpc-m5e666n89m2bx8jar****
    Token

    string

    用戶端 token（即自訂的唯一隨機字串）。

    tokenID
    Ip

    string

    執行個體的 IP 串連地址。

    rm-de21209****.mysql.rds.aliyuncs.com
    CallerUid

    string

    調用者使用者識別碼。

    31063db679****
    InstanceId

    string

    執行個體的 ID。

    rm-2ze1jdv45i7l6****
    Port

    integer

    目標執行個體的連接埠。

    3306
    OwnerId

    string

    所有者 ID。

    325352345
    Uuid

    string

    執行個體的唯一識別碼號。

    hdm_3063db6792965c080a4bcb6e6304****
    Error

    string

    錯誤訊息。

    InvalidRequestURL
    Code

    integer

    返回的狀態代碼。

    200
    Role

    string

    角色資訊。

    master
    TenantId

    string

    所屬的租戶 ID。

    L0EPfLS****=SCE00000*****
    Code

    string

    返回的狀態代碼。

    200
    Success

    string

    請求是否執行成功：

    • true：執行成功。

    • false：執行失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Synchro": "None",
  "Data": {
    "VpcId": "vpc-m5e666n89m2bx8jar****",
    "Token": "tokenID",
    "Ip": "rm-de21209****.mysql.rds.aliyuncs.com",
    "CallerUid": "31063db679****",
    "InstanceId": "rm-2ze1jdv45i7l6****",
    "Port": 3306,
    "OwnerId": "325352345",
    "Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
    "Error": "InvalidRequestURL",
    "Code": 200,
    "Role": "master",
    "TenantId": "L0EPfLS****=SCE00000*****"
  },
  "Code": "200",
  "Success": "true"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

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

    變更歷史

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