この API を呼び出して、ECS インスタンスの Web 管理端末 URL をクエリできます。

説明

本 API を呼び出す際は次の点に留意してください。

  • 管理端末の URL は 15 秒間のみ有効です。 クエリが成功してから 15 秒以内に接続が確立されない場合、URL は期限切れになり、再度クエリする必要があります。
  • 管理端末接続の KeepAlive 時間は60秒です。 60 秒以内に管理端末と対話しない場合、管理端末は自動的に切断されます。
  • 管理端末が切断されている場合、管理端末に再接続できるのは 1 分間に 30 回までです。
  • https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.5/index.html? の末尾に、vncUrl=xxxxinstanceId=xxxisWindows=TrueisWindows=False、およびpassword=XXXXXXを追加します。 これらのパラメーターを&で接続します。 ここで:
    • vncUrl:クエリの成功後にVncUrlの値が返されます。
    • instanceId:クエリするインスタンスの ID。
    • isWindows:インスタンスのオペレーティングシステムが Windows であるかどうかを指定します。 trueの値は Windows システムを示します。 falseの値は、Windows システムが使用されていないことを示します。
    • password:省略可能。 インスタンスからリモート接続を確立するためのパスワード。 長さは 6 文字である必要があり、数字、大文字、小文字を含めることができます。 このパラメーターにより、接続の確立時に管理端末でパスワードを入力する必要がなくなります。

      例 :
      
             https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.5/index.html?vncUrl=ws%3A%2F%xxx&instanceId=i-wz9hhwq5a6tmxxxxxxx&isWindows=true
             
      または
      
             https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.5/index.html?vncUrl=ws%3A%2F%xxx&instanceId=i-wz9hhwq5a6tmxxxxxxx&isWindows=true&password=111111
             

デバッグ

Alibaba Cloud は、API の使用を簡素化するためにOpenAPI Explorerを提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須/省略可能 説明
InstanceId String 必須 i-AY121018033933eaxxxxxxx

クエリされるインスタンスの ID。

RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID 。 DescribeRegionsを呼び出すと、最新のリージョンリストが表示されます。

Action String 省略可能 DescribeInstanceVncUrl

実行する操作。 値を DescribeInstanceVncUrl に設定します。

レスポンスパラメーター

パラメーター データ型 説明
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID 。

VncUrl String ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996

管理端末の URL。

リクエストの例

https://ecs.aliyuncs.com/?Action=DescribeInstanceVncUrl
&InstanceId=i-AY121018033933eaxxxxxxx
&RegionId=cn-hangzhou
&<Common request parameters>

通常のレスポンス例

XML 形式

<DescribeInstanceVncUrlResponse>
  <RequestId>1450F2D7-5435-4420-BBC9-49C5xxxxxxxx</RequestId>
  <VncUrl>ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996</VncUrl>
</DescribeInstanceVncUrlResponse>

JSON 形式

{
	"VncUrl":"ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996",
	"RequestId":"1450F2D7-5435-4420-BBC9-49C5xxxxxxxx"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定された DiskId パラメーターが存在しない場合に返されるエラーメッセージ。
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定された InstanceId パラメーターが存在しない場合に返されるエラーメッセージ。
403 IncorrectInstanceStatus The current status of the resource does not support this operation. リソースの現在のステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。
500 InternalError The request processing has failed due to some unknown error. 内部エラーが発生した場合に返されるエラーメッセージ。 しばらくしてからもう一度お試しください。 問題が解決しない場合は、チケットを起票してください。
403 InstanceNotReady The specified instance is not ready for use リソースの現在のステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。 数分後に再試行してください。

エラーコードの表示