インスタンスのリストを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dms:ListInstances |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 |
任意 |
1 ページあたりのエントリ数。値は 100 を超えることはできません。 |
50 |
| Region |
string |
任意 |
インスタンスのリージョン ID。 |
cn-hangzhou |
| RealLoginUserUid |
string |
任意 |
API オペレーションを実際に呼び出すユーザーの Alibaba Cloud アカウント ID。 |
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 |
インスタンスのオーナーユーザー ID のリスト。 |
|
|
string |
インスタンスのオーナーユーザー ID。 |
12**** |
|
| SafeRuleId |
string |
インスタンスのセキュリティルール ID。 |
1 |
| OwnerNameList |
object |
||
| OwnerNames |
array |
インスタンスのオーナーニックネームのリスト。 |
|
|
string |
インスタンスのオーナーニックネーム。 |
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 |
インスタンスのデータベースタイプ。 |
mysql |
| DatabasePassword |
string |
データベースユーザーパスワード。 |
****** |
| InstanceAlias |
string |
インスタンスエイリアス。 |
test |
| DdlOnline |
integer |
インスタンスの DdlOnline 構成。 |
1 |
| EcsRegion |
string |
インスタンスが属するリージョン。 |
cn-hangzhou |
| StandardGroup |
object |
インスタンスのコントロールモード情報。 |
|
| GroupName |
string |
コントロールモードに対応するセキュリティルールの名前。 |
test |
| GroupMode |
string |
コントロールモードタイプ。有効な値:
|
COMMON |
| SellSitd |
boolean |
機密データ保護が有効かどうかを示します。有効な値:
|
true |
| SellTrust |
string |
セキュリティホスティングが有効かどうかを示します。有効な値:
|
true |
| UseSsl |
integer |
||
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"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",
"UseSsl": 0
}
]
},
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。