Skip to content

CdnServiceApi.md

Latest commit

 

History

History
537 lines (354 loc) · 15.7 KB

CdnServiceApi.md

File metadata and controls

537 lines (354 loc) · 15.7 KB

OpenAPI\Client\CdnServiceApi

All URIs are relative to https://api.beget.com, except if the operation defines another base path.

Method HTTP request Description
cdnServiceChangeResourceDomains() POST /v1/cloud/cdn/{service_id}/resource-domains
cdnServiceChangeSetting() POST /v1/cloud/cdn/{service_id}/setting
cdnServiceGetIso3166Countries() GET /v1/cloud/cdn/iso3166-countries
cdnServiceGetIso3166Regions() POST /v1/cloud/cdn/iso3166-regions
cdnServiceGetPrice() GET /v1/cloud/cdn/price
cdnServiceGetSourceDomains() GET /v1/cloud/cdn/source-domains
cdnServicePreloadCacheByPaths() POST /v1/cloud/cdn/{service_id}/preload-cache-by-paths
cdnServicePurgeAllCache() GET /v1/cloud/cdn/{service_id}/purge-all-cache
cdnServicePurgeCacheByPaths() POST /v1/cloud/cdn/{service_id}/purge-cache-by-paths

cdnServiceChangeResourceDomains()

cdnServiceChangeResourceDomains($service_id, $cdn_change_resource_domains_request): \OpenAPI\Client\Model\CdnChangeResourceDomainsResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);
$service_id = 'service_id_example'; // string
$cdn_change_resource_domains_request = new \OpenAPI\Client\Model\CdnChangeResourceDomainsRequest(); // \OpenAPI\Client\Model\CdnChangeResourceDomainsRequest

try {
    $result = $apiInstance->cdnServiceChangeResourceDomains($service_id, $cdn_change_resource_domains_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CdnServiceApi->cdnServiceChangeResourceDomains: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
service_id string
cdn_change_resource_domains_request \OpenAPI\Client\Model\CdnChangeResourceDomainsRequest

Return type

\OpenAPI\Client\Model\CdnChangeResourceDomainsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServiceChangeSetting()

cdnServiceChangeSetting($service_id, $cdn_change_setting_request): \OpenAPI\Client\Model\CdnChangeSettingResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);
$service_id = 'service_id_example'; // string
$cdn_change_setting_request = new \OpenAPI\Client\Model\CdnChangeSettingRequest(); // \OpenAPI\Client\Model\CdnChangeSettingRequest

try {
    $result = $apiInstance->cdnServiceChangeSetting($service_id, $cdn_change_setting_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CdnServiceApi->cdnServiceChangeSetting: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
service_id string
cdn_change_setting_request \OpenAPI\Client\Model\CdnChangeSettingRequest

Return type

\OpenAPI\Client\Model\CdnChangeSettingResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServiceGetIso3166Countries()

cdnServiceGetIso3166Countries(): \OpenAPI\Client\Model\CdnGetCountriesResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\CdnGetCountriesResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServiceGetIso3166Regions()

cdnServiceGetIso3166Regions($cdn_get_regions_request): \OpenAPI\Client\Model\CdnGetRegionsResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);
$cdn_get_regions_request = new \OpenAPI\Client\Model\CdnGetRegionsRequest(); // \OpenAPI\Client\Model\CdnGetRegionsRequest

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

Parameters

Name Type Description Notes
cdn_get_regions_request \OpenAPI\Client\Model\CdnGetRegionsRequest

Return type

\OpenAPI\Client\Model\CdnGetRegionsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServiceGetPrice()

cdnServiceGetPrice(): \OpenAPI\Client\Model\CdnGetPriceResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\CdnGetPriceResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServiceGetSourceDomains()

cdnServiceGetSourceDomains(): \OpenAPI\Client\Model\CdnGetSourceDomainsResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\CdnGetSourceDomainsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServicePreloadCacheByPaths()

cdnServicePreloadCacheByPaths($service_id, $cdn_preload_cache_by_paths_request): \OpenAPI\Client\Model\CdnPreloadCacheByPathsResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);
$service_id = 'service_id_example'; // string
$cdn_preload_cache_by_paths_request = new \OpenAPI\Client\Model\CdnPreloadCacheByPathsRequest(); // \OpenAPI\Client\Model\CdnPreloadCacheByPathsRequest

try {
    $result = $apiInstance->cdnServicePreloadCacheByPaths($service_id, $cdn_preload_cache_by_paths_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CdnServiceApi->cdnServicePreloadCacheByPaths: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
service_id string
cdn_preload_cache_by_paths_request \OpenAPI\Client\Model\CdnPreloadCacheByPathsRequest

Return type

\OpenAPI\Client\Model\CdnPreloadCacheByPathsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServicePurgeAllCache()

cdnServicePurgeAllCache($service_id): \OpenAPI\Client\Model\CdnPurgeAllCacheResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);
$service_id = 'service_id_example'; // string

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

Parameters

Name Type Description Notes
service_id string

Return type

\OpenAPI\Client\Model\CdnPurgeAllCacheResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cdnServicePurgeCacheByPaths()

cdnServicePurgeCacheByPaths($service_id, $cdn_purge_cache_by_paths_request): \OpenAPI\Client\Model\CdnPurgeCacheByPathsResponse

Example

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


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


$apiInstance = new OpenAPI\Client\Api\CdnServiceApi(
    // 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
);
$service_id = 'service_id_example'; // string
$cdn_purge_cache_by_paths_request = new \OpenAPI\Client\Model\CdnPurgeCacheByPathsRequest(); // \OpenAPI\Client\Model\CdnPurgeCacheByPathsRequest

try {
    $result = $apiInstance->cdnServicePurgeCacheByPaths($service_id, $cdn_purge_cache_by_paths_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CdnServiceApi->cdnServicePurgeCacheByPaths: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
service_id string
cdn_purge_cache_by_paths_request \OpenAPI\Client\Model\CdnPurgeCacheByPathsRequest

Return type

\OpenAPI\Client\Model\CdnPurgeCacheByPathsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]