README

简介

Linode API 提供了通过程序管理 Linode 所有产品和服务的能力。

本参考旨在协助应用程序开发人员和系统管理员。每个端点都包括描述、请求语法以及使用标准 HTTP 请求的示例。响应数据以 JSON 格式返回。

本文件是根据我们的 OpenAPI 规范生成的。有关更多信息，请访问 <a target="_top" href="https://openapis.org.cn>OpenAPI</a> 网站。

<a target="_top" href="/docs/api/openapi.yaml">下载 Linode OpenAPI 规范。

变更日志

<a target="_top" href="https://developers.linode.com/changelog>查看我们的变更日志，了解我们对 API 所做的所有更改的说明。</a>

访问和认证

某些端点可以公开访问，无需认证。但是，影响您的所有端点都需要个人访问令牌或 OAuth 认证（当使用第三方应用程序时）。

个人访问令牌

通过 Linode 云管理器或 创建个人访问令牌 端点生成个人访问令牌（PAT）是最容易访问 API 的方式。

OAuth 安全模型的所有作用域（定义如下）也适用于此安全模型。

认证

OAuth

如果您只需要为个人用途访问 Linode API，我们建议您创建一个 个人访问令牌。如果您正在设计一个可以由任意 Linode 用户进行认证的应用程序，则应使用本节中介绍的 OAuth 2.0 工作流程。

有关 OAuth 2.0 实现的更详细示例，请参阅我们的指南：如何在 使用 Linode Python API 库创建 OAuth 应用程序。

在您的应用程序中实现 OAuth 之前，您首先需要创建一个 OAuth 客户端。您可以使用 Linode API 或 通过云管理器 来完成此操作。

• 在创建客户端时，您需要提供 label 和 redirect_uri（在云管理器中称为回调 URL）。
• 此端点的响应将为您提供 client_id 和 secret。
• 客户端可以是公开的或私有的，默认情况下是私有的。您可以在创建时选择将其设置为公开。
  • 私有客户端用于可以安全存储客户端密钥的应用程序（即，首次创建客户端时返回给您的密钥）。例如，运行在只有开发人员可以访问的安全服务器上的应用程序将使用私有 OAuth 客户端。在某些 OAuth 文档中，这也称为机密客户端。
  • 公开客户端用于客户端密钥无法保证安全的应用程序。例如，在用户计算机上运行的本地应用可能无法安全地存储客户端密钥，因为用户可以检查应用程序的源代码。因此，本地应用或运行在用户浏览器中的应用应使用公开客户端。
  • 公开和私有客户端遵循不同的工作流程，如下所述。

OAuth 工作流程

OAuth 工作流程是第三方应用程序与 Linode 之间的一系列交换。工作流程用于在应用程序代表用户进行 API 调用之前对用户进行身份验证。

注意

• 关于 RFC 6749 第 1.2 节中的图，login.linode.com（本节中称为 登录服务器）是资源所有者和授权服务器；api.linode.com（本节中称为 API 服务器）是资源服务器。
• OAuth 规范将以下列出的私有和公开工作流程称为 授权码流 和 隐式流。

OAuth 私有工作流程 - 更多详细信息

以下信息扩展了私有工作流程的第 5 到 7 步。

用户登录Linode并收到交换码后，您需要将此交换码兑换为access_token和refresh_token。您可以通过向以下地址发送HTTP POST请求来完成此操作

https://login.linode.com/oauth/token

以application/x-www-form-urlencoded或multipart/form-data的形式发送此请求，并在POST体中包含以下参数

您将获得如下响应

{
  \"scope\": \"linodes:read_write\",
  \"access_token\": \"03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c\"
  \"token_type\": \"bearer\",
  \"expires_in\": 7200,
}

响应中包含一个access_token。使用此令牌，您可以通过在每次请求中添加此头信息来继续对API进行认证HTTP请求

Authorization: Bearer 03d084436a6c91fbafd5c4b20c82e5056a2e9ce1635920c30dc8d81dc7a6665c

OAuth参考

请求

请求必须通过HTTPS发送，以确保事务加密。以下请求方法受到支持

响应

操作将返回以下HTTP响应状态码

错误

成功通过标准HTTP状态码表示。 2xx 状态码表示成功，4xx 状态码表示请求错误，而 5xx 错误表示服务器错误。请求错误可能是一个无效的输入，省略了必需的参数，或者请求格式不正确。服务器错误表示在处理您的请求时出了问题。如果发生这种情况，请提交支持工单并告诉我们。尽管我们会记录错误并迅速解决问题，但提交工单并为我们提供可复现的步骤和数据总是很有帮助的。

errors 字段是表示您的请求中出现问题的事物的数组。我们将尽可能在响应中包含尽可能多的问题，但在我们能够进一步处理您的请求之后，修复这些错误并重新提交可能会再次出现新的错误。

在每个错误对象中，如果错误与您提交的JSON中的特定字段相关，将包含 field 参数。如果没有相关字段，将省略此参数。 reason 是对错误的可读性解释，并且始终包含。

分页

资源列表始终分页。响应将类似于以下内容

{
    \"data\": [ ... ],
    \"page\": 1,
    \"pages\": 3,
    \"results\": 300
}

• 页码从1开始。您可以通过在URL中添加 ?page=x 来检索特定页面的结果（例如，?page=4）。如果 page 的值超过 2^64/page_size，则将返回最后一个可能的页面。

• 默认页面大小为100，可以设置为返回25到500之间的值。可以使用 ?page_size=x 设置页面大小。

过滤和排序

集合可以通过它们包含的字段进行搜索，在规范中标记为 x-linode-filterable: true。过滤器通过 X-Filter 标头传递，格式为JSON对象。以下是我们“标准”类中Linode类型的请求调用示例

curl \"https://api.linode.com/v4/linode/types\" \\
  -H '
    X-Filter: {
      \"class\": \"standard\"
    }'

过滤器对象的键是您正在过滤的对象的键，值是接受的值。您可以通过包含多个键来添加多个过滤器。例如，过滤“标准”Linode类型提供1个vcpu

 curl \"https://api.linode.com/v4/linode/types\" \\
  -H '
    X-Filter: {
      \"class\": \"standard\",
      \"vcpus\": 1
    }'

在上面的示例中，两个过滤器通过“与”操作组合。但是，如果您想要具有1个vcpu的类型或我们“标准”类中的类型，您可以添加一个运算符

curl \"https://api.linode.com/v4/linode/types\" \\
 -H '
   X-Filter: {
     \"+or\": [
       { \"vcpus\": 1 },
       { \"class\": \"standard\" }
     ]
   }'

在+or数组中，每个过滤器都是其自身的过滤器对象，其中所有的条件都通过“与”操作符进行组合，就像上一个例子中一样。

还有其他操作符可用。操作符是过滤器JSON对象的键。它们的值必须是适当的数据类型，并按照以下方式评估。

例如，过滤出内存等于或高于 61440 的Linode 类型

curl \"https://api.linode.com/v4/linode/types\" \\
  -H '
    X-Filter: {
      \"memory\": {
        \"+gte\": 61440
      }
    }'

您可以组合并嵌套操作符以构建任意复杂的查询。例如，给出所有既属于 standard 或 highmem 类，或者有 12 到 20 个 vcpus 的 Linode 类型

curl \"https://api.linode.com/v4/linode/types\" \\
  -H '
    X-Filter: {
      \"+or\": [
        {
          \"+or\": [
            {
              \"class\": \"standard\"
            },
            {
              \"class\": \"highmem\"
            }
          ]
        },
        {
          \"+and\": [
            {
              \"vcpus\": {
                \"+gte\": 12
              }
            },
            {
              \"vcpus\": {
                \"+lte\": 20
              }
            }
          ]
        }
      ]
    }'

速率限制

使用 Linode API，您可以每两分钟通过 IP 地址或 OAuth 令牌对每个用户进行最多 1,600 次通用 API 请求。此外，还定义了以下特定端点的限制。

注意：API之外可能存在速率限制，例如在负载均衡器上。

/stats 端点每分钟为每个用户的专用限制为 100 个请求。这些端点是

• 查看 Linode 统计数据
• 查看 Linode 统计数据（年/月）
• 查看 NodeBalancer 统计数据
• 列出管理统计信息

对象存储端点每秒为每个用户的专用限制为 750 个请求。对象存储端点是

• 对象存储端点

提交支持工单的专用限制为每分钟每个用户 2 个请求。该端点是

• 提交支持工单

接受服务迁移的专用限制为每分钟每个用户 2 个请求。该端点是

• 服务迁移接受

CLI（命令行界面）

<a href="https://github.com/linode/linode-cli" target="_top">Linode CLI允许您使用直观和简单的语法轻松使用 API。它需要一个个人访问令牌进行身份验证，并为您提供所有在此处用 CLI 例子记录的 Linode API 功能和功能。

没有 CLI 例子端点当前通过 CLI 不可用，但可以通过其他方法访问，如 Shell 命令和其他第三方应用程序。

有关更多信息，请访问 https://linode.com。

安装 & 使用

要求

PHP 7.3 及更高版本。也应在 PHP 8.0 上工作，但尚未经过测试。

Composer

通过Composer安装绑定，请在composer.json中添加以下内容

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门指南

请遵循安装步骤，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: oauth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure Bearer authorization: personalAccessToken
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$token = 'token_example'; // string | The UUID of the Entity Transfer.

try {
    $result = $apiInstance->acceptEntityTransfer($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->acceptEntityTransfer: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都相对于https://api.linode.com/v4

模型

• 账户
• 账户信用卡
• 账户设置
• 授权应用
• 备份
• 备份磁盘
• 信用卡
• 设备
• 设备列表
• 磁盘
• 磁盘请求
• 域名
• 域名记录
• 实体传输
• 实体传输实体
• 错误对象
• 事件
• 事件实体
• 事件辅助实体
• 防火墙
• 防火墙设备
• 防火墙设备实体
• 防火墙规则配置
• 防火墙规则配置地址
• 防火墙规则
• 授权
• 授权响应
• 全局授权响应
• IP地址
• 私有IP地址
• IPv6链路本地地址
• IPv6 SLAAC地址
• IPv6地址池
• IPv6地址范围
• 镜像
• 内联对象
• 内联对象1
• 内联对象10
• 内联对象11
• 内联对象12
• 内联对象13
• 内联对象14
• 内联对象15
• 内联对象16
• 内联对象17
• 内联对象18
• 内联对象19
• 内联对象2
• 内联对象20
• 内联对象21
• 内联对象3
• 内联对象4
• 内联对象5
• 内联对象6
• 内联对象7
• 内联对象8
• 内联对象9
• 内联响应200
• 内联响应2001
• 内联响应20010
• 内联响应20011
• 内联响应20012
• 内联响应20013
• 内联响应20014
• 内联响应20015
• 内联响应20016
• 内联响应20017
• 内联响应20018
• 内联响应20018快照
• 内联响应20019
• 内联响应2002
• 内联响应20020
• 内联响应20021
• 内联响应20022
• 内联响应20023
• 内联响应20024
• 内联响应20025
• 内联响应20026
• 内联响应20027
• 内联响应20028
• 内联响应20029
• 内联响应20029数据
• 内联响应2003
• 内联响应20030
• 内联响应20030数据
• 内联响应20031
• 内联响应20032
• 内联响应20033
• 内联响应20034
• 内联响应20035
• 内联响应20036
• 内联响应20037
• 内联响应20038
• 内联响应20039
• 内联响应2004
• 内联响应20040
• 内联响应20041
• 内联响应20042
• 内联响应20043
• 内联响应20044
• 内联响应20045
• 内联响应20046
• 内联响应20047
• 内联响应20048
• 内联响应20049
• 内联响应2005
• 内联响应20050
• 内联响应20051
• 内联响应20052
• 内联响应20053
• 内联响应20054
• 内联响应20055
• 内联响应20056
• 内联响应20057
• 内联响应20058
• 内联响应20059
• 内联响应2006
• 内联响应20060
• 内联响应2007
• 内联响应2008
• 内联响应2009
• 内联响应202
• 内联响应409
• 内联响应409错误
• 默认内联响应
• 发票
• 发票项目
• 内核
• LKE集群
• LKE节点池
• LKE节点池自动扩展
• LKE节点池磁盘
• LKE节点池请求体
• LKE节点池请求体自动扩展
• LKE节点状态
• LKE版本
• Linode
• Linode警报
• Linode备份
• Linode备份计划
• Linode配置
• Linode配置助手
• Linode配置接口
• Linode请求
• Linode规范
• Linode统计
• Linode统计I/O
• Linode统计IPv4
• Linode统计IPv6
• Linode类型
• Linode类型附加功能
• Linode类型附加功能备份
• Linode类型附加功能备份价格
• Linode类型价格
• 登录
• Longview客户端
• Longview客户端应用
• Longview计划
• Longview订阅
• Longview订阅价格
• 维护
• 维护实体
• 管理联系人
• 管理联系人电话
• 管理凭证
• 管理问题
• 管理问题实体
• 管理Linode设置
• 管理Linode设置SSH
• 管理服务
• 节点均衡器
• 节点均衡器配置
• 节点均衡器配置节点状态
• 节点均衡器节点
• 节点均衡器统计
• 节点均衡器统计数据
• 节点均衡器统计数据流量
• 节点均衡器传输
• 通知
• 通知实体
• OAuth客户端
• 对象存储存储桶
• 对象存储集群
• 对象存储密钥
• 对象存储密钥存储桶访问
• 对象存储对象
• 对象存储SSL
• 对象存储SSL响应
• 分页信封
• PayPal
• PayPal执行
• 支付
• 支付方式
• 支付方式数据
• 支付请求
• 个人访问令牌
• 个人资料
• 个人资料推荐
• 促销活动
• 地区
• 地区解析器
• 救援设备
• SSH密钥
• SSH密钥请求
• 服务迁移
• 服务迁移实体
• 栈脚本
• 统计数据
• 统计数据可用性
• 支持票据
• 支持票据实体
• 支持票据回复
• 支持票据请求
• 标签
• 迁移
• 可信设备
• 用户
• 用户自定义字段
• VLAN
• 卷
• 警告对象

授权

oauth

• 类型: OAuth
• 流程: accessCode
• 授权URL: https://login.linode.com/oauth/authorize
• 作用域:
  • account:read_only: 允许访问获取您的账户信息。
  • account:read_write: 允许访问与您的账户相关的所有端点。
  • domains:read_only: 允许访问获取您的域名。
  • domains:read_write: 允许访问所有域名端点。
  • events:read_only: 允许访问获取您的事件。
  • events:read_write: 允许访问与您的事件相关的所有端点。
  • firewall:read_only: 允许访问获取您的防火墙信息。
  • firewall:read_write: 允许访问所有防火墙端点。
  • images:read_only: 允许访问获取您的镜像。
  • images:read_write: 允许访问与您的镜像相关的所有端点。
  • ips:read_only: 允许访问获取您的IP。
  • ips:read_write: 允许访问与您的IP相关的所有端点。
  • linodes:read_only: 允许访问获取您的Linodes。
  • linodes:read_write: 允许访问与您的Linodes相关的所有端点。
  • lke:read_only: 允许访问获取您的LKE集群。
  • lke:read_write: 允许访问与您的LKE集群相关的所有端点。
  • longview:read_only: 允许访问获取您的Longview客户端。
  • longview:read_write: 允许访问与您的Longview客户端相关的所有端点。
  • maintenance:read_only: 允许访问获取您的账户维护信息。
  • nodebalancers:read_only: 允许访问获取您的NodeBalancers。
  • nodebalancers:read_write: 允许访问所有NodeBalancer端点。
  • object_storage:read_only: 允许访问获取与您的对象存储相关的信息。
  • object_storage:read_write: 允许访问所有对象存储端点。
  • stackscripts:read_only: 允许访问获取您的StackScripts。
  • stackscripts:read_write: 允许访问与您的StackScripts相关的所有端点。
  • volumes:read_only: 允许访问获取您的卷。
  • volumes:read_write: 允许访问与您的卷相关的所有端点。

个人访问令牌

• 类型: 带证认证

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

support@linode.com

关于此包

此PHP包由OpenAPI Generator项目自动生成

• API版本: 4.107.0
• 构建包: org.openapitools.codegen.languages.PhpClientCodegen