管理対象または非管理対象のインスタンスのリストと、そのインスタンス情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sysom:ListAllInstances |
list |
*すべてのリソース。
|
なし | なし |
リクエスト構文
GET /api/v1/am/instance/listAllInstances HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| region |
string |
任意 |
リージョン ID。 |
cn-hangzhou |
| instanceType |
string |
任意 |
インスタンスタイプ。 |
ecs |
| managedType |
string |
任意 |
管理タイプ。 |
managed |
| filters |
string |
任意 |
フィルター条件のリスト。 |
{} |
| current |
string |
任意 |
現在のページ番号。 |
1 |
| pageSize |
string |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。 |
10 |
| pluginId |
string |
任意 |
プラグイン ID。 |
01fc4a0b-f199-4885-9861-b4054a310fe7 |
| maxResults |
integer |
任意 |
1 回のリクエストで取得するレコード数の最大値。 |
100 |
| nextToken |
string |
任意 |
ページネーショントークン。 説明
このパラメーターが空でない場合、さらにデータが存在することを示します。 |
U+w1wv2R4ZWR5oZLXD0+Dp4dD+2BRJj42DLT6GrZysw= |
|
任意 |
||||
|
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ。 |
||
| requestId |
string |
リクエスト ID。 |
2D693121-C925-5154-8DF6-C09A8B369822 |
| code |
string |
状態コード。 |
Success |
| message |
string |
エラーメッセージ。
|
instance not exists |
| total |
integer |
クエリ結果の総数。 |
2 |
| data |
array<object> |
返されるデータ。 |
|
|
array<object> |
返される結果。 |
||
| instanceId |
string |
インスタンス ID。 |
i-bp17uabeke9v7n30abm2 |
| osHealthScore |
integer |
オペレーティングシステムのヘルススコア。 |
100 |
| resourceGroupName |
string |
リソースグループ名。 |
xxxx |
| instanceName |
string |
インスタンス名。 |
test |
| installType |
string |
インストールタイプ。 |
console |
| instanceType |
string |
インスタンスタイプ。 |
ecs |
| installLevel |
string |
インストールレベル。 |
Cluster |
| attributes |
array<object> |
拡張情報。 |
|
|
object |
拡張情報。 |
||
| infoValue |
string |
情報の値。 |
diagnosis |
| infoType |
string |
情報のタイプ。 |
instance_tag |
| infoKey |
string |
情報のキー。 |
sysom |
| resourceGroupId |
string |
リソースグループ ID。 |
3b24a621-acb3-11ef-8c90-00163e1029af |
| osName |
string |
オペレーティングシステム名。 |
alios |
| status |
string |
インスタンスの実行ステータス。有効な値:
説明
Offline 状態のインスタンスは、ノードから SysOM サーバーへのハートビートが失われたことを示します。これは、対応する ECS インスタンスが実行されていないことを意味するものではありません。 |
Running |
| clusterId |
string |
クラスター ID。 |
3b24a621-acb3-11ef-8c90-00163e1029af |
| osArch |
string |
オペレーティングシステムのシステムアーキテクチャー。 |
x86_64 |
| kernelVersion |
string |
カーネルバージョン。 |
5.10.134-18.al8.x86_64 |
| imageId |
string |
イメージ ID。 |
aliyun_3_x64_20G_alibase_20250117.vhd |
| manageType |
string |
管理タイプ。 |
managed |
| manageLevel |
string |
管理レベル。 |
cluster |
| clusterName |
string |
クラスター名。 |
zjk_vpc_domain_1 |
| publicIp |
string |
パブリック IP アドレス。 |
47.98.215.58 |
| privateIp |
string |
非公開 IP アドレス。 |
172.21.172.7 |
| agentConfigId |
string |
エージェント構成 ID。 |
test_id |
| agentConfigName |
string |
エージェント構成名。 |
test_name |
| maxResults |
integer |
返されるエントリの最大値。 |
20 |
| nextToken |
string |
ページネーショントークン。 説明
空でない値は、さらにデータが存在することを示します。 |
c2f78a783f49457caba6bace6f6f79e4 |
例
成功レスポンス
JSONJSON
{
"requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n",
"code": "Success",
"message": "instance not exists",
"total": 2,
"data": [
{
"instanceId": "i-bp17uabeke9v7n30abm2",
"osHealthScore": 100,
"resourceGroupName": "xxxx",
"instanceName": "test",
"installType": "console",
"instanceType": "ecs",
"installLevel": "Cluster",
"attributes": [
{
"infoValue": "diagnosis",
"infoType": "instance_tag",
"infoKey": "sysom"
}
],
"resourceGroupId": "3b24a621-acb3-11ef-8c90-00163e1029af",
"osName": "alios",
"status": "Running",
"clusterId": "3b24a621-acb3-11ef-8c90-00163e1029af",
"osArch": "x86_64",
"kernelVersion": "5.10.134-18.al8.x86_64",
"imageId": "aliyun_3_x64_20G_alibase_20250117.vhd",
"manageType": "managed",
"manageLevel": "cluster",
"clusterName": "zjk_vpc_domain_1",
"publicIp": "47.98.215.58",
"privateIp": "172.21.172.7",
"agentConfigId": "test_id",
"agentConfigName": "test_name"
}
],
"maxResults": 20,
"nextToken": "c2f78a783f49457caba6bace6f6f79e4"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Sysom.ServerError | Server error, please correct the code according to the error message. %s. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。