ListInstances
呼叫 ListInstances 介面，取得執行個體資訊列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:ListInstances |
list |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Tid |
integer |
否 |
租戶 ID，可透過呼叫介面 GetUserActiveTenant 取得該參數的值。 |
3*** |
| SearchKey |
string |
否 |
搜尋關鍵字。 |
test |
| DbType |
string |
否 |
資料庫類型，取值請參見 DbType 參數說明。 |
MySQL |
| EnvType |
string |
否 |
環境類型，取值如下：
|
product |
| InstanceSource |
string |
否 |
執行個體來源，取值如下：
|
RDS |
| NetType |
string |
否 |
執行個體網路類型，取值如下：
|
VPC |
| InstanceState |
string |
否 |
執行個體狀態，取值如下：
|
NORMAL |
| PageNumber |
integer |
否 |
第幾頁。 |
1 |
| PageSize |
integer |
否 |
每頁多少筆資料，取值不超過 100。 |
50 |
| Region |
string |
否 |
執行個體所在的 regionId。 |
cn-hangzhou |
| RealLoginUserUid |
string |
否 |
實際呼叫 API 的使用者的阿里雲帳號 UID。 |
21400447956867**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
描述。 |
||
| TotalCount |
integer |
滿足條件的執行個體總個數。 |
1 |
| RequestId |
string |
請求 ID。 |
B4B07137-F6AE-4756-8474-7F92BB6C4E04 |
| ErrorCode |
string |
錯誤碼。 |
UnknownError |
| ErrorMessage |
string |
錯誤資訊。 |
UnknownError |
| InstanceList |
object |
||
| Instance |
array<object> |
執行個體列表。 |
|
|
array<object> |
執行個體資訊。 |
||
| VpcId |
string |
執行個體所屬 VPC 的 ID。 |
vpc-o6wrloqsdqc9io3mg**** |
| DatabaseUser |
string |
資料庫使用者名稱。 |
dbUser |
| DbaId |
string |
執行個體 DBA ID。 |
31**** |
| UseDsql |
integer |
執行個體是否開啟跨庫查詢：
|
1 |
| Port |
integer |
執行個體串連連接埠。 |
3306 |
| EcsInstanceId |
string |
執行個體 ECS ID。 |
150**** |
| EnvType |
string |
執行個體環境類型，傳回值如下：
|
product |
| Sid |
string |
執行個體 Sid。 |
test |
| OwnerIdList |
object |
||
| OwnerIds |
array |
執行個體 Owner UserId 列表。 |
|
|
string |
執行個體 Owner UserId。 |
12**** |
|
| SafeRuleId |
string |
執行個體安全規則 ID。 |
1 |
| OwnerNameList |
object |
||
| OwnerNames |
array |
執行個體 Owner 暱稱列表。 |
|
|
string |
執行個體 Owner 暱稱。 |
yuyang_test |
|
| DbaNickName |
string |
執行個體 DBA 暱稱。 |
dbaName |
| QueryTimeout |
integer |
執行個體查詢逾時時間。 |
60 |
| InstanceSource |
string |
執行個體來源。 |
RDS |
| Host |
string |
執行個體串連地址。 |
****.mysql.rds.aliyuncs.com |
| State |
string |
執行個體狀態。 |
NORMAL |
| DataLinkName |
string |
DataLink 名稱。 |
dblink_test |
| ExportTimeout |
integer |
匯出逾時時間。 |
86400 |
| InstanceId |
string |
執行個體 ID。 |
150*** |
| InstanceType |
string |
執行個體 DB 類型。 |
mysql |
| DatabasePassword |
string |
資料庫使用者密碼。 |
****** |
| InstanceAlias |
string |
執行個體別名。 |
test |
| DdlOnline |
integer |
執行個體 DdlOnline 配置。 |
1 |
| EcsRegion |
string |
執行個體所屬地區。 |
cn-hangzhou |
| StandardGroup |
object |
執行個體對應的管控模式資訊。 |
|
| GroupName |
string |
管控模式對應的安全規則名稱。 |
test |
| GroupMode |
string |
管控模式類型，取值如下：
|
COMMON |
| SellSitd |
boolean |
Sensitive Data Discovery and Protection 是否開啟，取值：
|
true |
| SellTrust |
string |
是否開啟安全託管。取值：
|
true |
| Success |
boolean |
請求是否成功：
|
true |
樣本
正常返回樣本
JSON格式
{
"TotalCount": 1,
"RequestId": "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"InstanceList": {
"Instance": [
{
"VpcId": "vpc-o6wrloqsdqc9io3mg****",
"DatabaseUser": "dbUser",
"DbaId": "31****",
"UseDsql": 1,
"Port": 3306,
"EcsInstanceId": "150****",
"EnvType": "product",
"Sid": "test",
"OwnerIdList": {
"OwnerIds": [
"12****"
]
},
"SafeRuleId": "1",
"OwnerNameList": {
"OwnerNames": [
"yuyang_test"
]
},
"DbaNickName": "dbaName",
"QueryTimeout": 60,
"InstanceSource": "RDS",
"Host": "****.mysql.rds.aliyuncs.com",
"State": "NORMAL",
"DataLinkName": "dblink_test",
"ExportTimeout": 86400,
"InstanceId": "150***",
"InstanceType": "mysql",
"DatabasePassword": "******",
"InstanceAlias": "test",
"DdlOnline": 1,
"EcsRegion": "cn-hangzhou",
"StandardGroup": {
"GroupName": "test",
"GroupMode": "COMMON"
},
"SellSitd": true,
"SellTrust": "true"
}
]
},
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。