対象インスタンスが SysOM でサポートされているかどうかを確認します。
操作説明
この操作で返されるインスタンスリストには、すでに SysOM で管理されているインスタンスのみが含まれます。ECS インスタンスが存在しても SysOM で管理されていない場合は、リストに表示されません。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sysom:CheckInstanceSupport |
none |
*すべてのリソース。
|
なし | なし |
リクエスト構文
POST /api/v1/am/supportInstanceList/checkInstanceSupport HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディ。 |
|
| instances |
array |
任意 |
確認するインスタンス ID のリスト。 |
["i-2zxxxxxx"] |
|
string |
任意 |
インスタンスの ID。 |
i-2zxxxxxx |
|
| region |
string |
任意 |
インスタンスが属するリージョン。instances に指定されたすべてのインスタンス ID が同じリージョンに属していることを確認してください。 |
cn-hangzhou |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| code |
string |
状態コード。
|
Success |
| data |
array<object> |
応答データ。 |
|
|
object |
応答結果。 |
||
| instance |
string |
ECS インスタンスの ID。 |
i-wz9d00ut2ska3mlyhn6j |
| reason |
string |
インスタンスが管理対象としてサポートされていない理由。この値は、support が false の場合は空ではありません。 |
インスタンスが ECS に見つかりません |
| support |
boolean |
インスタンスが SysOM による管理対象としてサポートされているかどうかを示します。
|
true |
| message |
string |
エラーメッセージ。このフィールドには、コードが Success 以外の場合に詳細なエラー情報が含まれます。 |
SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom |
| requestId |
string |
リクエストの ID。 |
2D693121-C925-5154-8DF6-C09A8B369822 |
例
成功レスポンス
JSONJSON
{
"code": "Success",
"data": [
{
"instance": "i-wz9d00ut2ska3mlyhn6j",
"reason": "ECS にインスタンスが見つかりません",
"support": true
}
],
"message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
"requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。