DescribeInstanceVncUrl - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

操作説明

この API は直接使用できない VNC ログイン URL（VncUrl）を返します。管理端末 URL を通じてインスタンスにアクセスできます。

説明

管理端末 URL を構築するには、https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html? の末尾に vncUrl=\*\*\*\*、instanceId=****、isWindows=true/false を追加し、パラメーターを & で接続します。パラメーター:

vncUrl: VNC ログイン URL。
instanceId: インスタンス ID。
isWindows: インスタンスのオペレーティングシステムが Windows かどうかを指定します。値が true の場合は Windows を示します。値が false の場合は非 Windows を示します。
パスワード不要の VNC 接続がサポートされています。password パラメーターを設定する必要はありません。

単一の管理端末 URL のキープアライブ時間は 300 秒です。300 秒以内にインタラクションが発生しない場合、接続は自動的に閉じられます。
接続が中断された場合、この操作を再度呼び出して新しい VncUrl を取得し、新しい管理端末 URL を構築して再接続します。1 分あたり最大 30 回再接続できます。

管理端末 URL の例:

https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
```。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeInstanceVncUrl

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
InstanceId	string	必須	インスタンス ID	i-bp1hzoinajzkh91h****

レスポンスフィールド

フィールド	型	説明	例
	object
VncUrl	string	VNC ログイン URL。重要 VNC ログイン URL には時間制限があり、15 秒間有効です。呼び出し成功後 15 秒以内に URL を使用しない場合、URL は期限切れとなり、この操作を再度呼び出して新しい URL を取得する必要があります。。	wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "VncUrl": "wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidRegionInstance	The specified InstanceId does not exist in given region.
500	InternalError	The request processing has failed due to some unknown error.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	InstanceNotReady	The specified instance is not ready for use
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。