Lấy remote console
POST
/v2.1/servers/{server_id}/remote-consolesTrả về URL tạm thời để mở console của VM trong trình duyệt. Đây là API đứng sau nút console trên dashboard, và cũng là cách quay lại VM khi mạng hoặc SSH bị hỏng.
info
Nguồn: create-console
Request
Tham số
server_idstringbắt buộcpathUUID của VM.
remote_consoleobjectbắt buộcbodyObject bọc yêu cầu console.
2 trường
protocolstringbắt buộcbodyGiao thức console. Giá trị hợp lệ là vnc.
typestringbắt buộcbodyKiểu client console. Giá trị hợp lệ là novnc.
Request mẫu
Dùng curl
curl -ks -X POST -H 'Content-Type: application/json' \
-H 'X-OpenStack-Nova-API-Version: 2.8' -H 'X-Auth-Token: gAAAAA<...>' \
-d '{
"remote_console": {
"protocol": "vnc",
"type": "novnc"
}
}' https://api.vietnix.cloud:8774/v2.1/servers/{server_id}/remote-consoles
HTTP request
POST https://api.vietnix.cloud:8774/v2.1/servers/{server_id}/remote-consoles
Content-Type: application/json
X-OpenStack-Nova-API-Version: 2.8
X-Auth-Token: gAAAAA<...>
{
"remote_console": {
"protocol": "vnc",
"type": "novnc"
}
}
Response
Response mẫu
{
"remote_console": {
"protocol": "vnc",
"type": "novnc",
"url": "https://console.vietnix.cloud/vnc_auto.html?path=websockify&token=7d1f9c2e4b6a"
}
}
remote_console.protocolstringbắt buộcGiao thức console đã được cấp.
remote_console.typestringbắt buộcKiểu client đã được cấp.
remote_console.urlstringbắt buộcURL console. Mở URL này trong trình duyệt.
Mã trạng thái
Thành công
| Mã | Mô tả |
|---|---|
| 200 - OK | Đã trả về URL console. |
Lỗi
| Mã | Mô tả |
|---|---|
| 400 - Bad Request | Body của request hoặc các tham số không hợp lệ. |
| 401 - Unauthorized | User phải xác thực trước khi gửi request. |
| 403 - Forbidden | Policy không cho phép user hiện tại thực hiện thao tác này. |
| 404 - Not Found | VM không tồn tại, hoặc không hiển thị với project của bạn. |
| 409 - Conflict | VM đang ở trạng thái không thể truy cập bằng console. |
| 501 - Not Implemented | Remote console không được hỗ trợ cho VM hoặc deployment này. |
warning
URL này là bearer credential: bất kỳ ai có URL đều có thể xem và gõ vào console cho đến khi token hết hạn. Không dán URL vào ticket, chat hay log. Mỗi lần gọi trả về một token mới.