ウェブアクセラレータ公開API¶

[更新: 2024年12月19日]

「ウェブアクセラレータ」で利用可能なAPIについての説明です。curlコマンドなどでAPIのリクエストを送ることで使用することができます。

注釈

ご利用にはAPIキーが必要です。 APIキーの発行は APIキーの新規作成・編集をご確認ください。

全般的な仕様 ¶

API URL ¶

https://secure.sakura.ad.jp/cloud/zone/is1a/api/webaccel/1.0/

さくらのクラウドAPI とは異なり、ウェブアクセラレータのAPIでは常に is1a (石狩第1ゾーン) を指定してください。

認証 ¶

さくらのクラウドAPI と同様、APIキーとシークレットトークンを利用した Basic認証 または Digest認証 を使用します。APIキーとシークレットトークンは、コントロールパネルの APIキー管理で確認できます。

フォーマット ¶

リクエストのパラメータとレスポンスのフォーマットに JSON を使用しています。

プロトコル ¶

https でのアクセスのみ可能です。httpは使用できません。

文字コード ¶

文字コードは UTF-8 を使用しています。

日付のフォーマット ¶

Datetimeのフォーマットは ISO 8601 を使用しています。以下のような出力になります。

2013-01-14T09:30:00+09:00

レスポンスフォーマット ¶

さくらのクラウド API とは異なり、X-Sakura-API-Beautifyリクエストヘッダによるレスポンスの整形には対応しておりません。

リクエスト数制限 ¶

APIの実行目安は1時間500回以内となります。目安以上はAPIを実行しないでください。

APIレスポンス ¶

APIは以下に列挙されるHTTPレスポンスコードを返します。各APIでの具体的な意味合いはそれぞれの説明文中に記載しています。

ステータスコード	内容
200 OK	正常に処理され、何らかのレスポンスが返却された。
400 Bad Request	リクエストパラメータが不正等。
401 Unauthorized	認証に失敗した。
403 Forbidden	リソースへのアクセス権限がない。例：他の会員のサイトにアクセスしようとした。
404 Not Found	リソースが存在しない。例：000000000001 というサイトは存在しないのに /site/000000000001/certificate というリソースにアクセスした。
429 Too Many Requests	1アカウントでのリクエスト数が制限値に到達した。
500 Internal Server Error	内部エラーが発生した。例：DB接続に失敗した。
503 Service Unavailable	機能が停止している。例：メンテナンスによる機能停止。例：過負荷状態により一時的に機能停止している。

リクエストパラメータの共通仕様 ¶

ウェブアクセラレータのAPIではさくらのクラウド API のリクエストパラメータの共通仕様には対応しておりません。

月別使用量取得API ¶

URL	/monthlyusage?target=:target
Method	GET
内容	クラウドアカウントに登録されている全サイトの月別使用量を取得する。 targetフィールドの値は「yyyymm」形式で対象年月を指定する。 (例: 2021年02月の場合は、「202102」と指定。) 指定がない場合は、今月の月別使用量を取得する。

注意

対象年月は直近10年間以内の範囲で指定可能です。それ以前（10年以上前）の年月を指定した場合、情報を取得することはできませんのでご注意ください。

リクエストの例 ¶

GET https://secure.sakura.ad.jp/cloud/zone/is1a/api/webaccel/1.0/monthlyusage?target=202102 HTTP/1.1


リクエストボディ

なし

レスポンスボディ

{
  "Year": 2021,
  "Month": 2,
  "MonthlyUsages": [
    {
      "SiteID": "000000000001",
      "Domain": "cdn1.example.com",
      "ASCIIDomain": "cdn1.example.com",
      "Subdomain": "0f5cty4g.user.webaccel.jp",
      "AccessCount": 2070702,
      "BytesSent": 18524070906,
      "CacheMissBytesSent": 926203545,
      "CacheHitRatio": 85.138888888889,
      "BytesCacheHitRatio": 89.134258088490,
      "Price": 85
    },
    {
      "SiteID": "000000000002",
      "Domain": "さくら.example.jp",
      "ASCIIDomain": "xn--y8jl1n.example.jp",
      "Subdomain": "0uwjbk35.user.webaccel.jp",
      "AccessCount": 144,
      "BytesSent": 77784,
      "CacheMissBytesSent": 5724,
      "CacheHitRatio": 89.138888888889,
      "BytesCacheHitRatio": 92.641160135760,
      "Price": 0
    },
  ],
  "Success": true,
  "is_ok": true
}

URL	/site/:siteid
Method	PUT
内容	サイトの設定変更をする。

キー名	説明
Name	コントロールパネル「サイト名」に相当する設定項目。
RequestProtocol	コントロールパネル「リクエストプロトコル」に相当する設定項目。「0」「1」「2」のいずれかの数値を設定します。 0 … http/https , 1 … httpsのみ , 2 … httpsにリダイレクト
OriginType	コントロールパネル「オリジン種別」に相当する設定項目。「0」「1」のいずれかの数値を設定します。 0 … ウェブサーバ , 1 … オブジェクトストレージ
OriginProtocol	コントロールパネル「オリジンプロトコル」に相当する設定項目。「http」「https」のいずれかの文字列を設定します。 ※「オリジン種別」が「オブジェクトストレージ」の場合は「https」を指定する必要があります。
DefaultCacheTTL	コントロールパネル「デフォルトのキャッシュ期間」に相当する設定項目。「-1」または「0 ～ 604800 の範囲内」のいずれかの数値を設定します。 -1 … 無効 , 0 ～ 604800 の範囲内の数値 … デフォルトのキャッシュ期間(秒) ※「オリジン種別」が「オブジェクトストレージ」の場合は「500 ～ 604800」の範囲内の数値を指定する必要があります。
VarySupport	コントロールパネル「Varyサポート」に相当する設定項目。「0」「1」のいずれかの数値を設定します。 0 … 無効 , 1 … 有効
NormalizeAE	コントロールパネル「Accept-Encoding正規化」に相当する設定項目。「1」「3」のいずれかの数値を設定します。 1 … gzipに正規化 , 3 … brとgzipの組に正規化
CORSRules	コントロールパネル「CORS設定」に相当する設定項目。 AllowsAnyOrigin（全オリジン許可）または AllowedOrigins（許可オリジン）の項目を設定します。(設定例参照)
OnetimeURLSecrets	コントロールパネル「サイト全体ワンタイムURL設定」に相当する設定項目。シークレット(任意の文字列)を設定します。

キー名	説明
Origin	コントロールパネル「オリジンサーバ」に相当する設定項目。
HostHeader	コントロールパネル「ホストヘッダ」に相当する設定項目。

キー名	説明
BucketName	コントロールパネル「バケット名」に相当する設定項目。
S3Endpoint	コントロールパネル「S3エンドポイント」に相当する設定項目。
S3Region	コントロールパネル「S3リージョン」に相当する設定項目。
AccessKeyID	コントロールパネル「アクセスキーID」に相当する設定項目。
SecretAccessKey	コントロールパネル「シークレットアクセスキー」に相当する設定項目。
DocIndex	コントロールパネル「ドキュメントインデクス」に相当する設定項目。「0」「1」のいずれかの数値を設定します。 0 … 無効 , 1 … 有効

ウェブアクセラレータ 公開API¶

ウェブアクセラレータ公開API¶