# DGN Cloud API

> DGN 雲端資源 API 文件。契約版本 2.0, OpenAPI 3.0.3; API base URL: https://app.dgnlinks.com/api/v1.

連結以本檔所在位置解析。文件按公開 llms.txt 提案組織，無特定 AI 產品整合聲明。請依 OpenAPI 的明確型別、required、default、nullable、enum 與 Content-Type 撰寫整合，不推定未宣告欄位。API 金鑰必須由使用者於執行環境提供。

## 開始

- [快速開始](docs/quickstart.md): 契約版本、API 路徑、第一個唯讀請求與讀取方式。
- [OpenAPI JSON](openapi.json): 未修改的來源契約快照，適合型別與工具生成。
- [機器索引](docs/index.json): 105 個 operationId 與可機器讀取的相對連結。

## 命令列操作

- [DGN CLI](docs/guides/cli.md): 可執行 CLI 的安裝、認證、105 個 operationId、dry-run 與輸出約定。
- [dgn-cli-0.1.6.tgz](https://app.dgnlinks.com/console/docs/downloads/cli/v/0.1.6/dgn-cli-0.1.6.tgz): Node.js 22 以上的安裝包，安裝前按 CLI 指南驗證；未發布到 npm registry。

## 指南

- [驗證與權限](docs/guides/auth.md): 創建 API 密鑰，設定有效期、來源 IP 與每個端點需要的權限。
- [錯誤與限流](docs/guides/errors.md): 解析錯誤格式、處理請求上限，並保留排查失敗所需的資訊。
- [冪等請求](docs/guides/idempotency.md): 區分重試與新交易，避免建單、支付或續費時重複扣款。
- [通用約定](docs/guides/conventions.md): 掌握資料格式、資源狀態，以及欠費或維護期間的回應行為。
- [遷移至 2.0](docs/guides/migration.md): 逐項更新路徑、交易流程、資源 ID 與既有密鑰的權限。
- [DGN CLI](docs/guides/cli.md): 安裝命令列工具，以相同的 105 個 API 操作連接腳本與 AI。

## 帳戶

- [GET /account](docs/operations/getAccount.md): 查詢帳戶資訊. operationId: getAccount
- [GET /quotas](docs/operations/listQuotas.md): 查詢資源配額. operationId: listQuotas
- [GET /quotas/capacity](docs/operations/getQuotaCapacity.md): 配額容量試算. operationId: getQuotaCapacity

## 目錄

- [GET /catalog/disk-storage-config](docs/operations/getCatalogDiskStorageConfig.md): 查詢硬碟容量設定. operationId: getCatalogDiskStorageConfig
- [GET /catalog/disk-storage-types](docs/operations/listCatalogDiskStorageTypes.md): 列出雲盤類型. operationId: listCatalogDiskStorageTypes
- [GET /catalog/eip-network-types](docs/operations/listCatalogEipNetworkTypes.md): 列出彈性 IP 線路. operationId: listCatalogEipNetworkTypes
- [GET /catalog/eip-stock](docs/operations/getCatalogEipStock.md): 查詢彈性 IP 庫存. operationId: getCatalogEipStock
- [GET /catalog/images](docs/operations/listCatalogImages.md): 列出作業系統映像. operationId: listCatalogImages
- [GET /catalog/price-plans](docs/operations/listCatalogPricePlans.md): 列出計費週期. operationId: listCatalogPricePlans
- [GET /catalog/regions](docs/operations/listCatalogRegions.md): 列出地域. operationId: listCatalogRegions
- [GET /catalog/skus](docs/operations/listCatalogSkus.md): 列出可售規格. operationId: listCatalogSkus
- [GET /catalog/skus/{code}](docs/operations/getCatalogSkuByCode.md): 查詢規格詳情. operationId: getCatalogSkuByCode
- [GET /catalog/stock](docs/operations/getCatalogStock.md): 查詢雲主機庫存. operationId: getCatalogStock
- [GET /catalog/zones](docs/operations/listCatalogZones.md): 列出可用區. operationId: listCatalogZones

## SSH 公鑰

- [GET /ssh-keys](docs/operations/listSshKeys.md): 列出 SSH 公鑰. operationId: listSshKeys
- [POST /ssh-keys](docs/operations/createSshKey.md): 上傳 SSH 公鑰. operationId: createSshKey
- [POST /ssh-keys/generate](docs/operations/generateSshKey.md): 產生 SSH 金鑰對. operationId: generateSshKey
- [PATCH /ssh-keys/{id}](docs/operations/updateSshKey.md): 重新命名 SSH 公鑰. operationId: updateSshKey
- [DELETE /ssh-keys/{id}](docs/operations/deleteSshKey.md): 刪除 SSH 公鑰. operationId: deleteSshKey

## 雲主機

- [GET /operations/{id}](docs/operations/getVmOperation.md): 查詢操作進度. operationId: getVmOperation
- [GET /vms](docs/operations/listVms.md): 列出雲主機. operationId: listVms
- [GET /vms/{id}](docs/operations/getVm.md): 查詢雲主機詳情. operationId: getVm
- [PATCH /vms/{id}](docs/operations/updateVmMeta.md): 更新雲主機資料. operationId: updateVmMeta
- [GET /vms/{id}/access](docs/operations/vmAccess.md): 查詢 SSH 連線資訊. operationId: vmAccess
- [PUT /vms/{id}/auth](docs/operations/changeVmAuth.md): 變更登入憑證. operationId: changeVmAuth
- [GET /vms/{id}/metrics](docs/operations/vmMetrics.md): 查詢監控指標. operationId: vmMetrics
- [GET /vms/{id}/operations](docs/operations/vmOperations.md): 列出操作紀錄. operationId: vmOperations
- [POST /vms/{id}/password/rotate](docs/operations/rotateVmPassword.md): 重設 root 密碼. operationId: rotateVmPassword
- [POST /vms/{id}/reinstall](docs/operations/reinstallVm.md): 重裝作業系統. operationId: reinstallVm
- [POST /vms/{id}/reinstall/retry](docs/operations/retryReinstallVm.md): 重試系統重裝. operationId: retryReinstallVm
- [POST /vms/{id}/release](docs/operations/deleteVm.md): 釋放雲主機. operationId: deleteVm
- [POST /vms/{id}/release/quote](docs/operations/quoteDeleteVm.md): 預覽雲主機釋放退款. operationId: quoteDeleteVm
- [GET /vms/{id}/renew/quote](docs/operations/renewVmQuote.md): 查詢雲主機續費報價. operationId: renewVmQuote
- [POST /vms/{id}/renew](docs/operations/renewVm.md): 續費雲主機. operationId: renewVm
- [GET /vms/{id}/auto-renew](docs/operations/getVmAutoRenew.md): 查詢雲主機自動續費. operationId: getVmAutoRenew
- [PUT /vms/{id}/auto-renew](docs/operations/setVmAutoRenew.md): 開關雲主機自動續費. operationId: setVmAutoRenew
- [POST /vms/{id}/resize](docs/operations/resizeVm.md): 升級雲主機規格. operationId: resizeVm
- [POST /vms/{id}/resize/quote](docs/operations/quoteResizeVm.md): 預覽規格升級費用. operationId: quoteResizeVm
- [POST /vms/{id}/restart](docs/operations/restartVm.md): 重新啟動雲主機. operationId: restartVm
- [POST /vms/{id}/start](docs/operations/startVm.md): 啟動雲主機. operationId: startVm
- [POST /vms/{id}/stop](docs/operations/stopVm.md): 關閉雲主機. operationId: stopVm
- [PUT /vms/{id}/tags](docs/operations/tagsVm.md): 更新雲主機標籤. operationId: tagsVm
- [GET /vms/{id}/traffic-usage](docs/operations/vmTrafficUsage.md): 查詢雲主機流量. operationId: vmTrafficUsage
- [POST /vms/{id}/vnc-token](docs/operations/vmVncToken.md): 取得 VNC 連線票證. operationId: vmVncToken

## 雲盤

- [GET /disks](docs/operations/listDisks.md): 列出雲盤. operationId: listDisks
- [GET /disks/{id}](docs/operations/getDisk.md): 查詢雲盤詳情. operationId: getDisk
- [PATCH /disks/{id}](docs/operations/updateDisk.md): 更新雲盤資料. operationId: updateDisk
- [DELETE /disks/{id}](docs/operations/deleteDisk.md): 刪除雲盤. operationId: deleteDisk
- [POST /disks/{id}/attach](docs/operations/attachDisk.md): 掛載雲盤. operationId: attachDisk
- [POST /disks/{id}/detach](docs/operations/detachDisk.md): 卸載雲盤. operationId: detachDisk
- [POST /disks/{id}/expand](docs/operations/expandDisk.md): 擴充硬碟容量. operationId: expandDisk
- [GET /disks/{id}/expand/quote](docs/operations/expandDiskQuote.md): 查詢硬碟擴容報價. operationId: expandDiskQuote
- [GET /disks/{id}/refund-quote](docs/operations/refundQuote.md): 預覽硬碟刪除退款. operationId: refundQuote
- [GET /disks/{id}/renew/quote](docs/operations/renewDiskQuote.md): 查詢硬碟續費報價. operationId: renewDiskQuote
- [POST /disks/{id}/renew](docs/operations/renewDisk.md): 續費雲盤. operationId: renewDisk
- [PUT /disks/{id}/auto-renew](docs/operations/setDiskAutoRenew.md): 開關雲盤自動續費. operationId: setDiskAutoRenew

## 彈性公網 IP

- [GET /eips](docs/operations/listEips.md): 列出彈性 IP. operationId: listEips
- [GET /eips/recoverable](docs/operations/listRecoverableEips.md): 列出可找回的彈性 IP. operationId: listRecoverableEips
- [PUT /eips/{eipId}/package](docs/operations/attachPackageToEip.md): 設定共享頻寬包. operationId: attachPackageToEip
- [GET /eips/{id}](docs/operations/getEip.md): 查詢彈性 IP 詳情. operationId: getEip
- [PATCH /eips/{id}](docs/operations/updateEip.md): 更新彈性 IP 資料. operationId: updateEip
- [DELETE /eips/{id}](docs/operations/deleteEip.md): 釋放彈性 IP. operationId: deleteEip
- [POST /eips/{id}/bind](docs/operations/bindEip.md): 綁定彈性 IP. operationId: bindEip
- [GET /eips/{id}/renew/quote](docs/operations/renewEipQuote.md): 查詢彈性 IP 續費報價. operationId: renewEipQuote
- [POST /eips/{id}/renew](docs/operations/renewEip.md): 續費彈性 IP. operationId: renewEip
- [PUT /eips/{id}/auto-renew](docs/operations/setEipAutoRenew.md): 開關彈性公網 IP 自動續費. operationId: setEipAutoRenew
- [POST /eips/{id}/unbind](docs/operations/unbindEip.md): 解除彈性 IP 綁定. operationId: unbindEip

## VPC / 網卡

- [GET /nics](docs/operations/listNics.md): 列出網卡. operationId: listNics
- [GET /nics/{id}](docs/operations/getNic.md): 查詢網卡詳情. operationId: getNic
- [PATCH /nics/{id}](docs/operations/updateNic.md): 更新網卡資料. operationId: updateNic
- [GET /vpcs](docs/operations/listVpcs.md): 列出 VPC. operationId: listVpcs
- [GET /vpcs/{id}](docs/operations/getVpc.md): 查詢 VPC 詳情. operationId: getVpc
- [PATCH /vpcs/{id}](docs/operations/updateVpc.md): 更新 VPC 資料. operationId: updateVpc
- [DELETE /vpcs/{id}](docs/operations/deleteVpc.md): 刪除 VPC. operationId: deleteVpc

## 共享包

- [GET /bandwidth-packages](docs/operations/listBandwidthPackages.md): 列出共享頻寬包. operationId: listBandwidthPackages
- [GET /bandwidth-packages/{id}](docs/operations/getBandwidthPackage.md): 查詢共享頻寬包詳情. operationId: getBandwidthPackage
- [GET /traffic-packages](docs/operations/listTrafficPackages.md): 列出共享流量包. operationId: listTrafficPackages
- [GET /traffic-packages/{id}](docs/operations/getTrafficPackage.md): 查詢共享流量包詳情. operationId: getTrafficPackage
- [PATCH /traffic-packages/{id}](docs/operations/updateTrafficPackageMeta.md): 更新共享流量包資料. operationId: updateTrafficPackageMeta
- [PUT /traffic-packages/{id}/priority](docs/operations/updateTrafficPackagePriority.md): 設定流量包優先級. operationId: updateTrafficPackagePriority
- [GET /traffic-packages/{id}/usage](docs/operations/getTrafficPackageUsage.md): 查詢流量包用量. operationId: getTrafficPackageUsage
- [GET /traffic-packages/{id}/top-consumers](docs/operations/getTrafficPackageTopConsumers.md): 查詢流量消耗排行. operationId: getTrafficPackageTopConsumers
- [GET /traffic-packages/{id}/deductions](docs/operations/listTrafficPackageDeductions.md): 查詢流量抵扣明細. operationId: listTrafficPackageDeductions
- [GET /traffic-packages/{id}/deductions/export](docs/operations/exportTrafficPackageDeductions.md): 匯出流量抵扣明細. operationId: exportTrafficPackageDeductions

## 訂單與支付

- [GET /coupons](docs/operations/listCoupons.md): 列出優惠券. operationId: listCoupons
- [POST /coupons/preview](docs/operations/previewCoupons.md): 試算優惠券折扣. operationId: previewCoupons
- [GET /orders](docs/operations/listOrders.md): 列出訂單. operationId: listOrders
- [POST /orders/bandwidth-package](docs/operations/createBandwidthPackageOrder.md): 建立共享頻寬包訂單. operationId: createBandwidthPackageOrder
- [POST /orders/disk](docs/operations/createDiskOrder.md): 建立雲盤訂單. operationId: createDiskOrder
- [POST /orders/eip](docs/operations/createEipOrder.md): 建立彈性 IP 訂單. operationId: createEipOrder
- [POST /orders/traffic-package](docs/operations/createTrafficPackageOrder.md): 建立共享流量包訂單. operationId: createTrafficPackageOrder
- [POST /orders/vm](docs/operations/createVmOrder.md): 建立雲主機訂單. operationId: createVmOrder
- [GET /orders/{id}](docs/operations/getOrder.md): 查詢訂單詳情. operationId: getOrder
- [GET /orders/{id}/delivery](docs/operations/getOrderDelivery.md): 查詢訂單交付進度. operationId: getOrderDelivery
- [GET /orders/{id}/payments](docs/operations/listOrderPayments.md): 列出訂單付款紀錄. operationId: listOrderPayments
- [POST /orders/{id}/payments](docs/operations/payOrder.md): 支付訂單. operationId: payOrder
- [POST /orders/{id}/void](docs/operations/voidOrder.md): 作廢未付款訂單. operationId: voidOrder

## 錢包與賬單

- [GET /statements](docs/operations/listStatements.md): 列出月結單. operationId: listStatements
- [GET /statements/{period}](docs/operations/getStatement.md): 查詢月結單詳情. operationId: getStatement
- [GET /statements/{period}/pdf-url](docs/operations/getStatementPdfUrl.md): 取得月結單 PDF. operationId: getStatementPdfUrl
- [GET /wallet](docs/operations/getWallet.md): 查詢錢包餘額. operationId: getWallet
- [GET /wallet/consumptions](docs/operations/listConsumptions.md): 列出資源消費明細. operationId: listConsumptions
- [GET /wallet/journals](docs/operations/listWalletJournals.md): 列出資金流水. operationId: listWalletJournals
- [GET /wallet/journals/export](docs/operations/exportWalletJournals.md): 匯出資金流水. operationId: exportWalletJournals
- [GET /wallet/overview](docs/operations/getBillOverview.md): 查詢帳單總覽. operationId: getBillOverview

## Optional

- [完整文件](llms-full.txt): 所有指南與端點全文，含遞迴相依定義。
- [English](en/llms.txt): 英文文件索引。