タグリストやパブリック IP アドレスリストなど、インスタンスの ECS 情報リストを取得します。
操作説明
この操作で取得されるインスタンスリストには、SysOM によって管理されているマシンのみが含まれます。ECS インスタンスが存在しても、SysOM によって管理されていない場合はリストに表示されません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sysom:ListInstancesEcsInfoList |
get |
*すべてのリソース。
|
なし | なし |
リクエスト構文
GET /api/v1/am/instance/listInstancesEcsInfoList HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| region |
string |
必須 |
インスタンスのフィルターに使用するリージョン。 |
cn-shenzhen |
| info_type |
string |
必須 |
取得する情報のタイプ。 |
ip |
| managed_type |
string |
任意 |
インスタンスの管理ステータス。 |
managed |
| instance_id |
string |
任意 |
指定したインスタンスのエージェントインストールステータスをフィルター処理するためのインスタンス ID を指定します。 |
i-bp118piqcio9tiwgh84b |
| plugin_id |
string |
任意 |
対応するコンポーネントのインスタンス情報リストをフィルター処理するためのコンポーネント ID を指定します。 |
74a86327-3170-412c-8e67-da3389ec56a9 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| code |
string |
エラーコード。 |
SysomOpenAPI.InvalidParameter |
| data |
array<object> |
返されるデータ。 |
|
|
object |
返される結果。 |
||
| ip |
string |
マシンの IP アドレス。 |
11.193.52.91 |
| tag_key |
string |
タグ名。 |
sysom |
| tag_value |
string |
タグ値。 |
diagnosis |
| type |
string |
IP アドレスタイプ。 |
public |
| message |
string |
エラーメッセージ。
|
"" |
例
成功レスポンス
JSONJSON
{
"code": "SysomOpenAPI.InvalidParameter",
"data": [
{
"ip": "11.193.52.91",
"tag_key": "sysom",
"tag_value": "diagnosis",
"type": "public"
}
],
"message": "\"\""
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。