API Spinner#

Để sử dụng API Spinner, người dùng làm theo các hướng dẫn dưới đây:

Pre-condition

  • Access vào Workspace.

Bước 1: Tạo Access Key cho Spinner.#

Vào màn hình Container Spinner > API > Access Key ở menu bên trái để tạo Access key cho Spinner

Nhấn Create New Access Key để tạo mới

Step

Popup Create Access Key hiển thị, người dùng điền đầy đủ thông tin yêu cầu.

  • Điền Access Key name

Step
  • Điền Description nếu có

Step
  • Chọn hoặc thêm Spinner và các quyền mong muốn

Step
  • Người dùng có thể set ngày hết hạn cho key

Step

Sau đó nhấn Save And Download để lưu lại.

Step

Bước 2: Set API Spinner.#

Vào màn hình Container Spinner > API > API ở menu bên trái.

Step
  1. Đọc thông tin Spinner:

Người dùng nhấn vào Try it out để điền thông tin.

Step
  • Api-key: là chuỗi được encode dạng base64 từ chuỗi <accessKey>:<secretKey> với giá trị được cung cấp từ file access key đã tạo ở bước 1.

VD: UWSKGHJRNYQVZFPC9C6OUW==:2D021057-7256-46DD-8D26-5B76370A5CD1

Với: accessKey (chuỗi màu đỏ), secretKey (chuỗi màu xanh lá)

  • spinnerUUID: lấy từ Spinner access key list.

Step
  • workspaceUUID: là UUID của workspace.

Step

Sau khi điền thông tin, nhấn Execute.

Step
  1. Thay đổi thông tin Spinner:

Step
  • Api-key: lấy từ chuỗi <accessKey>:<secretKey> được encode dạng base64.

  • request: Nhập thông tin thay đổi cho spinner

  1. Đọc thông tin container:

Step
  • Api-key: lấy từ chuỗi <accessKey>:<secretKey> được encode dạng base64.

  • containerName: điền tên container, lấy từ list containers.

  • spinnerUUID: UUID của spinner.

  • workspaceUUID: UUID của workspace.

  1. Đọc các giá trị của environment:

Step
  • Điền Api-key

  • containerName: điền tên container, lấy từ list containers.

  • environmentName: lên environment

  • spinnerUUID: UUID của spinner.

  • workspaceUUID: UUID của workspace.

  1. Thay đổi image tag và biến môi trường:

Step
  • Điền Api-key

  • Điền thông tin cần thay đổi.

  1. Đọc thông tin các container thuộc spinner:

Step
  • Điền Api-key

  • spinnerUUID: UUID của spinner.

  • workspaceUUID: UUID của workspace.

Result:

Sau khi chạy Execute, Responses trả về kết quả 200 là thành công.