All Products
Search

This Product

    Elastic Compute Service:DescribeInstanceVncUrl

    Document Center

    Elastic Compute Service:DescribeInstanceVncUrl

    Last Updated:Jun 18, 2026

    Mengkueri URL login VNC dari instans ECS.

    Deskripsi operasi

    • API ini mengembalikan URL login VNC (VncUrl) yang tidak dapat digunakan secara langsung. Anda dapat mengakses instans melalui URL terminal manajemen.

    Catatan

    Untuk membuat URL terminal manajemen, tambahkan vncUrl=\*\*\*\*, instanceId=****, dan isWindows=true/false ke akhir https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?, lalu hubungkan parameter dengan &. Parameter:

    • vncUrl: URL login VNC.

    • instanceId: ID instans.

    • isWindows: menentukan apakah sistem operasi instans adalah Windows. Nilai true menunjukkan Windows. Nilai false menunjukkan non-Windows.

    • Koneksi VNC tanpa kata sandi didukung. Anda tidak perlu mengatur parameter password.

    • Waktu KeepAlive dari satu URL terminal manajemen adalah 300 detik. Jika tidak ada interaksi dalam 300 detik, koneksi akan ditutup secara otomatis.

    • Jika koneksi terputus, panggil operasi ini lagi untuk mendapatkan VncUrl baru dan buat URL terminal manajemen baru untuk menyambung kembali. Anda dapat menyambung kembali hingga 30 kali per menit.

    Contoh URL terminal manajemen:

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

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ecs:DescribeInstanceVncUrl

    get

    *Instance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID region instans. Anda dapat memanggil DescribeRegions untuk mengkueri daftar region terbaru.

    cn-hangzhou
    InstanceId

    string

    Yes

    ID instans.

    i-bp1hzoinajzkh91h****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    VncUrl

    string

    URL login VNC.

    Penting URL login VNC bersifat sensitif terhadap waktu dan hanya berlaku selama 15 detik. Jika Anda tidak menggunakan URL dalam waktu 15 detik setelah panggilan berhasil, URL akan kedaluwarsa dan Anda harus memanggil operasi ini lagi untuk mendapatkan yang baru.
    .

    wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
    RequestId

    string

    ID permintaan.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidRegionInstance The specified InstanceId does not exist in given region. Instance tidak ada di region yang ditentukan. Periksa apakah parameter sudah valid.
    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. ID region yang ditentukan tidak ada.
    404 InvalidInstanceId.NotFound The specified InstanceId does not exist. ID instance yang ditentukan tidak valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.