呼叫 GetInstance 以獲取 DMS 執行個體元數據 - 資料管理

擷取執行個體詳細資料。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetInstance

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID，可通過調用介面 GetUserActiveTenant 擷取該參數的值。	2***
Host	string	是	執行個體串連地址，可通過調用介面 ListInstances 擷取該參數的值。	172.17.XXX.XXX
Port	integer	是	執行個體串連連接埠，可通過調用介面 ListInstances 擷取該參數的值。	5432
Sid	string	否	執行個體 Sid，可調用介面 ListInstances 擷取該參數的值。	test
RealLoginUserUid	string	否

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	F6C80B69-3203-56AC-8021-18BA72A6F4E1
Instance	object	執行個體詳細資料。
VpcId	string	執行個體所屬 VPC 的 ID。	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	執行個體登入使用者名稱。	dbuser
DbaId	string	執行個體 DBA ID。	29****
UseDsql	integer	執行個體是否開啟跨庫查詢： 0：不開啟 1：開啟	0
Port	integer	執行個體串連連接埠。	5432
EcsInstanceId	string	執行個體 ECS ID。	i-bp124ldpklqz59y3****
EnvType	string	執行個體環境類型，傳回值如下： product：生產環境 dev：開發環境 pre：預發環境 test：測試環境 sit：SIT 環境 uat：UAT 環境 pet：壓測環境 stag：STAG 環境	test
Sid	string	執行個體 Sid。	test
OwnerIdList	object
OwnerIds	array	執行個體 Owner UserId 列表。
	string	執行個體 Owner UserId。	10****
SafeRuleId	string	執行個體安全規則 ID。	3****
OwnerNameList	object
OwnerNames	array	執行個體 Owner 暱稱列表。
	string	執行個體 Owner 暱稱。	yang_test
DbaNickName	string	執行個體 DBA 暱稱。	dbaname
QueryTimeout	integer	執行個體查詢逾時時間。	7200
InstanceSource	string	執行個體來源。	ECS_OWN
Host	string	執行個體串連地址。	192.168.XXX.XXX
State	string	執行個體狀態，傳回值如下： NORMAL：正常使用 DISABLE：禁用	NORMAL
DataLinkName	string	執行個體 Datalink 名稱。	test
ExportTimeout	integer	執行個體匯出逾時時間。	86400
InstanceId	string	執行個體 ID。	188****
InstanceType	string	執行個體 DB 類型。	postgresql
DatabasePassword	string	資料庫使用者密碼。	******
InstanceAlias	string	執行個體別名。	測試
DdlOnline	integer	執行個體 DdlOnline 配置。	0
EcsRegion	string	執行個體所屬地區。	cn-beijing
StandardGroup	object	執行個體對應的管控模式資訊。
GroupName	string	管控模式對應的安全規則名稱。	自由操作
GroupMode	string	管控模式類型，傳回值如下： COMMON：安全協同模式 NONE_CONTROL：自由操作模式 STABLE：穩定變更模式	NONE_CONTROL
SellSitd	string	Sensitive Data Discovery and Protection是否開啟，取值： true：開啟 false：關閉	false
SellTrust	string
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功，傳回值如下： true：請求成功 false：請求失敗	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
  "Instance": {
    "VpcId": "vpc-o6wrloqsdqc9io3mg****",
    "DatabaseUser": "dbuser",
    "DbaId": "29****",
    "UseDsql": 0,
    "Port": 5432,
    "EcsInstanceId": "i-bp124ldpklqz59y3****",
    "EnvType": "test",
    "Sid": "test",
    "OwnerIdList": {
      "OwnerIds": [
        "10****"
      ]
    },
    "SafeRuleId": "3****",
    "OwnerNameList": {
      "OwnerNames": [
        "yang_test"
      ]
    },
    "DbaNickName": "dbaname",
    "QueryTimeout": 7200,
    "InstanceSource": "ECS_OWN",
    "Host": "192.168.XXX.XXX",
    "State": "NORMAL",
    "DataLinkName": "test",
    "ExportTimeout": 86400,
    "InstanceId": "188****",
    "InstanceType": "postgresql",
    "DatabasePassword": "******",
    "InstanceAlias": "測試",
    "DdlOnline": 0,
    "EcsRegion": "cn-beijing",
    "StandardGroup": {
      "GroupName": "自由操作",
      "GroupMode": "NONE_CONTROL"
    },
    "SellSitd": "false",
    "SellTrust": ""
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

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