insidieux/power-dns-client

此包已被放弃且不再维护。未建议替代包。

1.0.0 2018-11-14 09:47 UTC

This package is auto-updated.

Last update: 2023-02-27 22:27:28 UTC


README

此项目非常过时,落后于当前php的实际版本,以及Power DNS API的当前版本。我们强烈不建议您使用此库,并建议您切换到github/packagist上发布的任何包。

未提供描述(由Openapi Generator生成 https://github.com/openapitools/openapi-generator

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

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

要求

PHP 5.5 及以上

安装与使用

Composer

要通过Composer安装绑定,请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/insidieux/power-dns-client.git"
    }
  ],
  "require": {
    "insidieux/power-dns-client": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/power-dns-client/vendor/autoload.php');

测试

运行单元测试

composer install
./vendor/bin/phpunit

入门

请遵循 安装过程,然后运行以下命令

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

// Configure API key authorization: APIKeyHeader
$config = insidieux\PowerDnsClient\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = insidieux\PowerDnsClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new insidieux\PowerDnsClient\Api\ConfigApi(
    // 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
);
$serverId = 'serverId_example'; // string | The id of the server to retrieve

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

?>

API端点文档

所有URI相对于 https://:8081/api/v1

方法 HTTP请求 描述
ConfigApi getConfig GET /servers/{server_id}/config 返回单个服务器的所有ConfigSettings
ConfigApi getConfigSetting GET /servers/{server_id}/config/{config_setting_name} 返回单个服务器的特定ConfigSetting
SearchApi searchData GET /servers/{server_id}/search-data 在PowerDNS内部搜索数据
ServersApi cacheFlushByName PUT /servers/{server_id}/cache/flush 通过名称刷新缓存条目
ServersApi listServer GET /servers/{server_id} 列出服务器
ServersApi listServers GET /servers 列出所有服务器
StatsApi getStats GET /servers/{server_id}/statistics 查询统计数据。
ZonecryptokeyApi createCryptokey POST /servers/{server_id}/zones/{zone_id}/cryptokeys 创建一个Cryptokey
ZonecryptokeyApi deleteCryptokey DELETE /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} 此方法通过cryptokey_id删除指定的密钥。
ZonecryptokeyApi getCryptokey GET /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} 返回关于CryptoKey的所有数据,包括私钥。
ZonecryptokeyApi listCryptokeys GET /servers/{server_id}/zones/{zone_id}/cryptokeys 获取一个区域的所有CryptoKeys,除了私钥
ZonecryptokeyApi modifyCryptokey PUT /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} 此方法根据cryptokey_id激活或停用指定区域名中的密钥
ZonemetadataApi createMetadata POST /servers/{server_id}/zones/{zone_id}/metadata 创建一组元数据条目
ZonemetadataApi deleteMetadata DELETE /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} 删除单个类型域元数据的所有条目。
ZonemetadataApi getMetadata GET /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} 以元数据对象列表的形式获取单个类型域元数据的内容。
ZonemetadataApi listMetadata GET /servers/{server_id}/zones/{zone_id}/metadata 获取与区域关联的所有元数据。
ZonemetadataApi modifyMetadata PUT /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} 修改单个类型域元数据的内容。
ZonesApi axfrExportZone GET /servers/{server_id}/zones/{zone_id}/export 以AXFR格式返回区域。
ZonesApi axfrRetrieveZone PUT /servers/{server_id}/zones/{zone_id}/axfr-retrieve 从其主区域检索从区域。
ZonesApi checkZone GET /servers/{server_id}/zones/{zone_id}/check 验证区域内容/配置。
ZonesApi createZone POST /servers/{server_id}/zones 创建一个新的域名,返回创建时的区域。
ZonesApi deleteZone DELETE /servers/{server_id}/zones/{zone_id} 删除此区域,所有关联的元数据和rrsets。
ZonesApi listZone GET /servers/{server_id}/zones/{zone_id} 由服务器管理的区域
ZonesApi listZones GET /servers/{server_id}/zones 列出服务器中的所有区域
ZonesApi notifyZone PUT /servers/{server_id}/zones/{zone_id}/notify 向所有从服务器发送DNS NOTIFY。
ZonesApi patchZone PATCH /servers/{server_id}/zones/{zone_id} 在有效载荷中创建/修改/删除RRsets及其注释。在成功时返回204 No Content。
ZonesApi putZone PUT /servers/{server_id}/zones/{zone_id} 修改基本区域数据(元数据)。
ZonesApi rectifyZone PUT /servers/{server_id}/zones/{zone_id}/rectify 校正区域数据。

模型文档

授权文档

APIKeyHeader

  • 类型: API密钥
  • API密钥参数名: X-API-Key
  • 位置: HTTP头

作者