當您需要修改實例的托管模式、數(shù)據(jù)庫賬密、功能包等基本信息,及環(huán)境類型、實例在DMS的名稱、查詢和導(dǎo)出數(shù)據(jù)的超時時間等高級信息時,可調(diào)用該API。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dms:ModifyInstance | update | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。您可調(diào)用 ListInstances 或 GetInstance 接口獲取該參數(shù)的值。 | 183**** |
Tid | long | 否 | 租戶 ID。 說明
取自 DMS 控制臺頁面右上角頭像處懸停展示的租戶 ID 信息。
| 23**** |
InstanceType | string | 否 | 數(shù)據(jù)庫類型,取值請參見 DbType 參數(shù)說明。 | MySQL |
InstanceSource | string | 否 | 實例來源,取值如下:
| RDS |
NetworkType | string | 否 | 網(wǎng)絡(luò)類型,取值如下:
| VPC |
EnvType | string | 否 | 環(huán)境類型,取值如下:
| dev |
EcsInstanceId | string | 否 | ECS 的實例 ID。 說明
如果 InstanceSource 取值為 ECS_OWN,此值必填。
| i-2zei9gs1t7h8l7ac**** |
VpcId | string | 否 | 實例 VPC ID。 說明
如果 InstanceSource 取值為 VPC_IDC 時,此值必填。
| vpc-bp10wnlcmor**** |
EcsRegion | string | 否 | 實例所在地域。 說明
如果 InstanceSource 取值為 RDS、ECS_OWN 或 VPC_IDC,此值必填。
| cn-hangzhou |
Host | string | 否 | 實例連接地址。 | 192.XXX.0.56 |
Port | integer | 否 | 實例訪問端口。 | 3306 |
Sid | string | 否 | 實例 Sid。 說明
如果 InstanceType 為 ORACLE,此項必填。
| testSid |
DatabaseUser | string | 否 | 數(shù)據(jù)庫賬號。 | testsdb |
DatabasePassword | string | 否 | 數(shù)據(jù)庫密碼。 | test*** |
InstanceAlias | string | 否 | 實例別名,幫助用戶快速區(qū)分定位該實例。 | instance_test |
DbaId | long | 否 | 實例 DBA 角色的用戶 ID,可調(diào)用接口 ListUsers 或 GetInstance 獲取該參數(shù)的值。 | 27**** |
QueryTimeout | integer | 否 | 查詢超時時間,單位:s(秒)。 | 7200 |
ExportTimeout | integer | 否 | 導(dǎo)出超時時間,單位:s(秒)。 | 86400 |
EnableSellTrust | string | 否 | 實例是否需要開啟安全托管。
| Y |
EnableSellStable | string | 否 | 實例是否需要開通穩(wěn)定變更功能。
| NULL |
EnableSellCommon | string | 否 | 實例是否需要開通安全協(xié)同功能。
| Y |
SafeRule | string | 否 | 若您需要開通安全協(xié)同功能包,則需要為該實例設(shè)置安全規(guī)則集(GroupName)。您可調(diào)用 ListStandardGroups 或 GetInstance 接口獲取該參數(shù)的值。 | 金融線-生產(chǎn) |
EnableSellSitd | string | 否 | 是否需要為該實例開啟敏感數(shù)據(jù)保護功能。
| Y |
DataLinkName | string | 否 | 輸入跨庫查詢 datalink 名稱。 說明
| dblink_test |
DdlOnline | integer | 否 | 是否開啟結(jié)構(gòu)變更優(yōu)先,取值如下:
說明
支持的數(shù)據(jù)庫類型:RDS MySQL、PolarDB MySQL 引擎、MyBase MySQL、其他來源 MySQL。
| 2 |
UseDsql | integer | 否 | 是否啟用跨實例查詢,取值如下:
說明
支持的數(shù)據(jù)庫類型:MySQL、SQL Server、PostgreSQL、PolarDB O 引擎、Redis。
| 1 |
SkipTest | boolean | 否 | 實例是否忽略測試連通性。取值如下:
| false |
TemplateId | long | 否 | 分類分級模板 ID。您可調(diào)用 ListClassificationTemplates 接口獲取該參數(shù)的值。 | 31*** |
TemplateType | string | 否 | 分類分級模板類型。您可調(diào)用 ListClassificationTemplates 獲取該參數(shù)的值。 | INNER |
UseSsl | integer | 否 | 選擇是否開啟 SSL 連接,開啟后,DMS 將通過 SSL 連接到數(shù)據(jù)庫。使用該參數(shù)的前提是數(shù)據(jù)庫已開啟 SSL 連接,當前支持如下選項:
說明
| 0 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-03-20 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |