ECS 情報を含む、管理対象および非管理対象のインスタンスに関する情報を取得します。
操作説明
この操作によって返されるインスタンスリストには、SysOM によって管理されているマシンだけが含まれます。ECS インスタンスが存在しても SysOM によって管理されていない場合、そのインスタンスはリストに表示されません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sysom:ListInstancesWithEcsInfo |
get |
*すべてのリソース。
|
なし | なし |
リクエスト構文
GET /api/v1/am/instance/listInstancesWithEcsInfo HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| region |
string |
必須 |
リージョンでインスタンスをフィルタリングします。 |
cn-shenzhen |
| instance_id |
string |
任意 |
指定したインスタンスのエージェントインストールステータスをフィルタリングするためのインスタンス ID を指定します。 |
i-bp118piqcio9tiwgh84b |
| instance_name |
string |
任意 |
コンポーネントインスタンスの名前。 |
block-load-balancer-hjdm9 |
| instance_id_name |
string |
任意 |
インスタンス名またはインスタンス ID でインスタンスをフィルタリングします。あいまい一致をサポートします。 |
84b |
| is_managed |
integer |
任意 |
管理ステータスでインスタンスをフィルタリングします。 |
1 |
| instance_tag |
object |
任意 |
インスタンスのタグでインスタンスをフィルタリングします。 |
|
| key |
string |
任意 |
タグキー。 |
feature_dim_radar_chart |
| value |
string |
任意 |
タグ値。 |
test |
| public_ip |
string |
任意 |
パブリック IP アドレスでインスタンスをフィルタリングします。 |
1.1.1.1 |
| private_ip |
string |
任意 |
非公開 IP アドレスでインスタンスをフィルタリングします。 |
1.1.1.1 |
| resource_group_name |
string |
任意 |
リソースグループ名でインスタンスをフィルタリングします。 |
デフォルトリソースグループ |
| resource_group_id |
string |
任意 |
リソースグループ ID でインスタンスをフィルタリングします。 |
rg-xxxxxxx |
| resource_group_id_name |
string |
任意 |
リソースグループ名またはリソースグループ ID でインスタンスをフィルタリングします。あいまい一致をサポートします。 |
デフォルト |
| health_status |
string |
任意 |
正常性ステータスでインスタンスをフィルタリングします。 |
healthy |
| os_name |
string |
任意 |
オペレーティングシステム名でインスタンスをフィルタリングします。 |
Alibaba Cloud Linux 3.2104 LTS 64bit |
| current |
integer |
任意 |
ページネーションのページ番号。このフィールドは現在のページを示します。 |
1 |
| pageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| code |
string |
状態コード。 |
Success |
| data |
array<object> |
返されるデータ。 |
|
|
array<object> |
返される結果。 |
||
| cluster_id |
string |
クラスター ID。 |
cbf7a37bc905d4682a3338b3744810269 |
| instance_id |
string |
インスタンス ID。 |
i-bp118piqcio9tiwgh84b |
| instance_name |
string |
インスタンス名。 |
allowed-repos-r2tzl |
| instance_tag |
array<object> |
インスタンスのタグ。 |
|
|
object |
|||
| tag_key |
string |
タグキー。 |
test_tag_key |
| tag_value |
string |
タグ値。 |
テストタグ値 |
| kernel_version |
string |
カーネルバージョン。 |
5.10.134-14.an8.x86_64 |
| os_arch |
string |
ECS インスタンスのアーキテクチャ。 |
x86 |
| os_health_score |
string |
インスタンスの正常性スコア。 |
100 |
| os_name |
string |
インスタンスのオペレーティングシステム名。 |
Alibaba Cloud Linux 3.2104 LTS 64bit |
| private_ip |
string |
インスタンスの非公開 IP アドレス。 |
1.1.1.1 |
| public_ip |
string |
インスタンスのパブリック IP アドレス。 |
1.1.1.1 |
| resource_group_id |
string |
リソースグループ ID。 |
rg-xxxxxx |
| resource_group_name |
string |
リソースグループ名。 |
デフォルトリソースグループ |
| status |
string |
インスタンスの実行ステータス。有効な値:
説明
Offline 状態のインスタンスは、ノードと SysOM サーバー間のハートビートが失われていることを示します。これは、対応する ECS インスタンスが実行されていないことを意味するものではありません。 |
Running |
| message |
string |
エラーメッセージ。空の値は、すべてのデータの読み取りが完了したことを示します。 |
結果: コード=1 メッセージ=(リクエスト失敗、状態コード != 200) |
| request_id |
string |
リクエスト ID。 |
35F91AAB-5FDF-5A22-B211-C7C6B00817D0 |
| total |
integer |
レコードの総数。 |
319 |
例
成功レスポンス
JSONJSON
{
"code": "Success",
"data": [
{
"cluster_id": "cbf7a37bc905d4682a3338b3744810269",
"instance_id": "i-bp118piqcio9tiwgh84b",
"instance_name": "allowed-repos-r2tzl",
"instance_tag": [
{
"tag_key": "test_tag_key",
"tag_value": "test_tag_value"
}
],
"kernel_version": "5.10.134-14.an8.x86_64",
"os_arch": "x86",
"os_health_score": "100",
"os_name": "Alibaba Cloud Linux 3.2104 LTS 64bit",
"private_ip": "1.1.1.1",
"public_ip": "1.1.1.1",
"resource_group_id": "rg-xxxxxx",
"resource_group_name": "default resource group",
"status": "Running"
}
],
"message": "result: code=1 msg=(Request failed, status_code != 200)",
"request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
"total": 319
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。