账户 API 参考
Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。
共 55 个端点,其中 18 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/overviewRegions with their system images, the packages you can order, and your account's server limits | 只读 | — | orbit compute overviewcompute_overview |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/instancesYour servers | 只读 | — | orbit compute instances listcompute_instances_list |
POST /compute/instancesCreate a server: region, package, system image, host name and SSH keys. Answers 202 with the queued job | 读写 | 请求体: JSON | orbit compute instances createcompute_instances_create |
GET /compute/instances/{id}One server: state, power, the job in progress, addresses, resources and this period's traffic | 只读 | id string | orbit compute instances get <id>compute_instances_get |
GET /compute/instances/{id}/optionsWhat a server can switch to: packages, system images, ISO images and private networks | 只读 | id string | orbit compute instances options <id>compute_instances_options |
POST /compute/instances/{id}/actionPower: start, shutdown, stop or reboot | 读写 | id string请求体: JSON | orbit compute instances action <id>compute_instances_action |
POST /compute/instances/{id}/destroyDestroy a server and its disk; confirm with its host name | 读写 | id string请求体: JSON | orbit compute instances destroy <id>compute_instances_destroy |
POST /compute/instances/{id}/consoleOpen the graphical (vnc) or serial console: a one-time link valid for five minutes | 读写 | id string请求体: JSON | orbit compute instances console <id>compute_instances_console |
GET /compute/instances/{id}/usageHourly network, disk and CPU usage (at most 92 days) | 只读 | id string?from string?to string | orbit compute instances usage <id>compute_instances_usage |
GET /compute/instances/{id}/metricsGraph series: CPU, memory, network and disk over 1h, 1d, 1w or 1m | 只读 | id string?range string | orbit compute instances metrics <id>compute_instances_metrics |
GET /compute/instances/{id}/jobsRecent operations on a server | 只读 | id string | orbit compute instances jobs <id>compute_instances_jobs |
POST /compute/instances/{id}/reinstallReinstall from a system image (erases the disk); confirm with the host name | 读写 | id string请求体: JSON | orbit compute instances reinstall <id>compute_instances_reinstall |
POST /compute/instances/{id}/resizeSwitch to another package (the server restarts; the disk only grows) | 读写 | id string请求体: JSON | orbit compute instances resize <id>compute_instances_resize |
POST /compute/instances/{id}/passwordSet a new root password; the answer shows it once | 读写 | id string请求体: JSON | orbit compute instances password <id>compute_instances_password |
POST /compute/instances/{id}/hostnameChange the host name | 读写 | id string请求体: JSON | orbit compute instances hostname <id>compute_instances_hostname |
POST /compute/instances/{id}/rescueStart in rescue mode, or leave it ({on: true|false}) | 读写 | id string请求体: JSON | orbit compute instances rescue <id>compute_instances_rescue |
POST /compute/instances/{id}/isoInsert an ISO image ({iso_id}) or eject it ({iso_id: null}) | 读写 | id string请求体: JSON | orbit compute instances iso <id>compute_instances_iso |
GET /compute/instances/{id}/snapshotsSnapshots of a server | 只读 | id string | orbit compute instances snapshots get <id>compute_instances_snapshots_get |
POST /compute/instances/{id}/snapshotsTake a snapshot | 读写 | id string请求体: JSON | orbit compute instances snapshots create <id>compute_instances_snapshots_create |
POST /compute/instances/{id}/snapshots/{snap}/rollbackRoll the server back to a snapshot | 读写 | id stringsnap string请求体: JSON | orbit compute instances snapshots rollback <id> <snap>compute_instances_snapshots_rollback |
DELETE /compute/instances/{id}/snapshots/{snap}Delete a snapshot | 读写 | id stringsnap string | orbit compute instances snapshots delete <id> <snap>compute_instances_snapshots_delete |
GET /compute/instances/{id}/backupsBackups of a server | 只读 | id string | orbit compute instances backups get <id>compute_instances_backups_get |
POST /compute/instances/{id}/backupsBack up a server now | 读写 | id string请求体: JSON | orbit compute instances backups create <id>compute_instances_backups_create |
POST /compute/instances/{id}/backups/{backup}/restoreRestore a backup over the server's disk | 读写 | id stringbackup string请求体: JSON | orbit compute instances backups restore <id> <backup>compute_instances_backups_restore |
DELETE /compute/instances/{id}/backups/{backup}Delete a backup | 读写 | id stringbackup string | orbit compute instances backups delete <id> <backup>compute_instances_backups_delete |
GET /compute/instances/{id}/firewallThe server's firewall: on or off, default policies and rules | 只读 | id string | orbit compute instances firewall get <id>compute_instances_firewall_get |
PUT /compute/instances/{id}/firewallReplace the firewall settings and rules | 读写 | id string请求体: JSON | orbit compute instances firewall put <id>compute_instances_firewall_put |
GET /compute/instances/{id}/rdnsReverse DNS of the server's addresses | 只读 | id string | orbit compute instances rdns get <id>compute_instances_rdns_get |
PUT /compute/instances/{id}/rdnsSet or remove the reverse DNS name of an address ({address, ptr}) | 读写 | id string请求体: JSON | orbit compute instances rdns put <id>compute_instances_rdns_put |
POST /compute/instances/{id}/ipv4Add an IPv4 address | 读写 | id string请求体: JSON | orbit compute instances ipv4 add <id>compute_instances_ipv4_add |
DELETE /compute/instances/{id}/ipv4/{assignment}Remove an added IPv4 address | 读写 | id stringassignment string | orbit compute instances ipv4 remove <id> <assignment>compute_instances_ipv4_remove |
PUT /compute/instances/{id}/security-groupsSet a VPC server's security groups ({ids}, 1 to 5) | 读写 | id string请求体: JSON | orbit compute instances security_groups put <id>compute_instances_security_groups_put |
POST /compute/instances/{id}/networksPut the server on a private network ({network_id}) | 读写 | id string请求体: JSON | orbit compute instances networks attach <id>compute_instances_networks_attach |
DELETE /compute/instances/{id}/networks/{network}Take the server off a private network | 读写 | id stringnetwork string | orbit compute instances networks detach <id> <network>compute_instances_networks_detach |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/jobs/{id}One operation: queued, running, done or failed | 只读 | id string | orbit compute jobs get <id>compute_jobs_get |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/vpcsYour VPCs (private networks of a region) with their subnets | 只读 | ?region_id string | orbit compute vpcs listcompute_vpcs_list |
POST /compute/vpcsCreate a VPC in a region: {region_id, name, size: 20–28 (default 24)}; its range is chosen from the region's private pool and it gets a first subnet | 读写 | 请求体: JSON | orbit compute vpcs createcompute_vpcs_create |
GET /compute/vpcs/{id}One VPC with its subnets | 只读 | id string | orbit compute vpcs get <id>compute_vpcs_get |
PATCH /compute/vpcs/{id}Rename a VPC | 读写 | id string请求体: JSON | orbit compute vpcs patch <id>compute_vpcs_patch |
DELETE /compute/vpcs/{id}Delete a VPC with no servers in it | 读写 | id string | orbit compute vpcs delete <id>compute_vpcs_delete |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
POST /compute/vpcs/{id}/subnetsAdd a subnet to a VPC: {name, size} (a block of the VPC's range) | 读写 | id string请求体: JSON | orbit compute subnets create <id>compute_subnets_create |
DELETE /compute/subnets/{id}Delete a subnet with no servers in it (a VPC keeps at least one) | 读写 | id string | orbit compute subnets delete <id>compute_subnets_delete |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/eipsYour elastic public IPs and what they are bound to | 只读 | ?region_id string | orbit compute eips listcompute_eips_list |
POST /compute/eipsAllocate an elastic public IP in a region: {region_id, name} | 读写 | 请求体: JSON | orbit compute eips allocatecompute_eips_allocate |
POST /compute/eips/{id}/associateBind the elastic IP to a VPC server ({server_id}); bound to another server, it moves in one step | 读写 | id string请求体: JSON | orbit compute eips associate <id>compute_eips_associate |
POST /compute/eips/{id}/disassociateUnbind the elastic IP from its server (the server then has no internet access, in or out) | 读写 | id string请求体: JSON | orbit compute eips disassociate <id>compute_eips_disassociate |
DELETE /compute/eips/{id}Release an unbound elastic IP | 读写 | id string | orbit compute eips release <id>compute_eips_release |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/security-groupsYour security groups with their rules | 只读 | ?region_id string | orbit compute security_groups listcompute_security_groups_list |
POST /compute/security-groupsCreate a security group: {region_id, name, description, policy_in, policy_out, rules: [{direction, action, proto, dport, source (address, network or sg:<id>), comment}]} | 读写 | 请求体: JSON | orbit compute security_groups createcompute_security_groups_create |
GET /compute/security-groups/{id}One security group | 只读 | id string | orbit compute security_groups get <id>compute_security_groups_get |
PATCH /compute/security-groups/{id}Change a security group (rules are replaced as a whole); its servers follow | 读写 | id string请求体: JSON | orbit compute security_groups patch <id>compute_security_groups_patch |
DELETE /compute/security-groups/{id}Delete a security group no server uses | 读写 | id string | orbit compute security_groups delete <id>compute_security_groups_delete |
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /compute/networksYour private networks | 只读 | — | orbit compute networks getcompute_networks_get |
POST /compute/networksCreate a private network in a region | 读写 | 请求体: JSON | orbit compute networks createcompute_networks_create |
DELETE /compute/networks/{id}Delete a private network with no servers on it: 204 when it never reached a host, otherwise 202 while it is removed from the hosts (state deleting) | 读写 | id string | orbit compute networks delete <id>compute_networks_delete |