All Products
Search

This Product

    Elastic Compute Service:DescribeTerminalSessions

    Document Center

    Elastic Compute Service:DescribeTerminalSessions

    Last Updated:Sep 20, 2026

    Mengkueri riwayat sesi Session Manager.

    Deskripsi operasi

    Anda dapat mengkueri catatan sesi Session Manager yang dibuat dalam 30 hari terakhir. Maksimal 1.000 catatan berhasil disimpan.

    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:DescribeTerminalSessions

    list

    *Instance.

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah.

    cn-hangzhou
    InstanceId

    string

    No

    ID instans.

    i-bp1i7gg30r52z2em****
    SessionId

    string

    No

    ID sesi.

    s-hz023od0x9****
    MaxResults

    integer

    No

    Jumlah maksimum entri per halaman untuk kueri berhalaman.

    Nilai maksimum: 100.

    Nilai default: 10.

    10
    NextToken

    string

    No

    Token paginasi. Atur parameter ini ke nilai NextToken yang dikembalikan dalam panggilan API sebelumnya.

    AAAAAdDWBF2****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    NextToken

    string

    Token paginasi yang dikembalikan dalam panggilan ini.

    AAAAAdDWBF2****
    RequestId

    string

    ID permintaan.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    Sessions

    object

    Session

    array<object>

    Daftar sesi.

    array<object>

    Informasi sesi.

    ClientIP

    string

    Alamat IP klien dari koneksi jarak jauh.

    192.168.1.1
    Connections

    object

    Connection

    array<object>

    Daftar informasi koneksi.

    object

    Informasi koneksi.

    ClosedReason

    string

    Alasan penutupan koneksi. Parameter ini hanya dikembalikan ketika Status adalah Disconnected, Terminated, atau Failed. Nilai valid:

    • InstanceNotExists: Instans yang ditentukan tidak ada atau telah dilepas.

    • InstanceNotRunning: Instans tidak berjalan.

    • DeliveryTimeout: Waktu koneksi habis.

    • AgentNeedUpgrade: Agen Asisten Cloud perlu ditingkatkan.

    • AgentNotOnline: Agen Asisten Cloud tidak terhubung ke server.

    • MessageFormatInvalid: Format Paket tidak valid.

    • AgentSocketClosed: Koneksi ditutup secara normal.

    • ClientClosed: Klien manajemen sesi menutup koneksi.

    • ReadFromTargetPortFailed: Gagal membaca data dari port target selama penerusan data dengan PortNumber yang ditentukan di StartTerminalSession.

    • ReopenTargetPortFailed: Gagal membangun kembali koneksi TCP ke port target selama penerusan data dengan PortNumber yang ditentukan di StartTerminalSession.

    • OpenTargetPortFailed: Gagal membangun koneksi TCP ke port target selama penerusan data dengan PortNumber yang ditentukan di StartTerminalSession.

    • WinptyPermissionDenied: Untuk instans Windows, gagal memberikan izin baca dan eksekusi pada winpty.dll atau winpty-agent.exe kepada pengguna yang ditentukan.

    • PasswordNameNotFound: PasswordName yang ditentukan di StartTerminalSession tidak ditemukan.

    • ProcessSessionDataError: Gagal memproses data sesi.

    • SessionIdDuplicate: ID sesi duplikat.

    • SessionTimeout: Waktu sesi habis. Koneksi sesi yang melebihi 3 jam akan diputuskan secara proaktif.

    • IdleTimeout: Waktu tunggu koneksi habis. Koneksi tanpa interaksi sesi selama 180 detik dianggap tidak aktif dan diputuskan secara proaktif.

    • HomeDirPermissionDenied: Izin tidak cukup pada direktori home pengguna yang akan dihubungkan.

    • HomeDirNotFound: Direktori home pengguna yang akan dihubungkan tidak ada.

    • ShellCommandPermissionDenied: Izin tidak cukup pada program shell. bash atau csh tidak memiliki izin eksekusi.

    • ShellCommandNotFound: Program shell tidak ada. File bash di Linux, file csh di FreeBSD, atau file powershell.exe di Windows tidak ada.

    • ObtainUserInfoFailed: Gagal memperoleh informasi parameter Username (informasi direktori home).

    • ObtainUserIdentityFailed: Gagal memperoleh informasi otentikasi parameter Username (uid, gid, groups).

    • UserNotExists: Username yang ditentukan di StartTerminalSession tidak ada.

    • MalformedCommandLine: Gagal mengurai CommandLine yang ditentukan di StartTerminalSession.

    AgentNeedUpgrade
    EndTime

    string

    Waktu ketika koneksi berakhir. Waktu ditampilkan dalam format ISO 8601 UTC.

    2024-01-19T09:16:46Z
    FailedDetail

    string

    Detail kegagalan koneksi. Parameter ini hanya dikembalikan ketika Status adalah Failed.

    Session Manager ditutup secara normal
    InstanceId

    string

    ID instans.

    i-bp1i7gg30r52z2em****
    StartTime

    string

    Waktu ketika koneksi dimulai. Waktu ditampilkan dalam format ISO 8601 UTC.

    2024-01-19T09:16:40Z
    Status

    string

    Status sesi. Nilai valid:

    • Connecting: Sesi sedang dihubungkan.

    • Connected: Sesi terhubung.

    • Terminated: Sesi dihentikan.

    • Failed: Koneksi gagal.

    Connecting
    CreationTime

    string

    Waktu ketika sesi dibuat. Waktu ditampilkan dalam format ISO 8601 UTC.

    2024-01-19T09:15:46Z
    IdentityType

    string

    Tipe identitas. Nilai valid:

    • Account: Akun Alibaba Cloud.

    • RAMUser: Pengguna RAM.

    • AssumedRoleUser: Peran RAM.

    RAMUser
    PortNumber

    integer

    Nomor port instans ECS yang digunakan untuk penerusan data. Jika tidak ada nomor port yang dikonfigurasi untuk penerusan data, nilai ini kosong.

    22
    PrincipalId

    string

    ID identitas. Nilai bervariasi berdasarkan IdentityType:

    • Jika pemanggil adalah akun Alibaba Cloud: ID akun Alibaba Cloud dikembalikan.

    • Jika pemanggil adalah Pengguna RAM: ID Pengguna RAM dikembalikan.

    • Jika pemanggil memanggil API melalui asumsi peran: ID delegasi aktual dari asumsi peran dikembalikan.

    123456xxxx
    SessionId

    string

    ID sesi.

    s-hz023od0x9****
    TargetServer

    string

    Alamat server target di VPC yang diakses melalui instans.

    192.168.0.246
    Username

    string

    Nama pengguna yang digunakan untuk koneksi.

    root

    Contoh

    Respons sukses

    JSONformat

    {
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Sessions": {
    "Session": [
      {
        "ClientIP": "192.168.1.1",
        "Connections": {
          "Connection": [
            {
              "ClosedReason": "AgentNeedUpgrade",
              "EndTime": "2024-01-19T09:16:46Z",
              "FailedDetail": "Session Manager ditutup secara normal",
              "InstanceId": "i-bp1i7gg30r52z2em****",
              "StartTime": "2024-01-19T09:16:40Z",
              "Status": "Connecting"
            }
          ]
        },
        "CreationTime": "2024-01-19T09:15:46Z",
        "IdentityType": "RAMUser",
        "PortNumber": 22,
        "PrincipalId": "123456xxxx",
        "SessionId": "s-hz023od0x9****",
        "TargetServer": "192.168.0.246",
        "Username": "root"
      }
    ]
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.NextToken The specified parameter NextToken is not valid.
    400 InvalidParameter.MaxResults The specified parameter MaxResults is not valid. Parameter MaxResults yang ditentukan tidak valid.
    500 InternalError An error occurred when you dispatched the request. Terjadi error internal. Coba lagi.
    403 InvalidParameterCharacter The specified parameter %s contains illegal characters.
    403 Operation.Forbidden The operation is not permitted. Operasi tidak diizinkan.
    404 InvalidRegionId.NotFound The specified parameter RegionId does not exist. RegionId yang ditentukan tidak ada. Periksa apakah produk tersedia di wilayah ini.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.