Edit a service#

service_idで指定する配信設定を編集します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://cdn.gls.cloud.global.fujitsu.com
東日本リージョン3の場合 https://cdn.gls.cloud.global.fujitsu.com

HTTPメソッドとURI#

PATCH

/v1/services/{service_id}/param{?status, container, object_prefix, key_container, key_object}

キャッシュ動作制御ルールを更新する場合、差分ではなく全部を指定する必要があります。また、statusも同時に指定する必要があります。status変更だけの場合は、前回指定したキャッシュ動作制御ルールが使用されます。

HTTPステータスコード#

正常時：200, 202

エラー時：400, 409

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
X-Auth-Token header string 必須 ユーザー認証を行った際に取得するトークン
Content-Type header string 任意 リクエストボディで指定する情報がJSON形式の場合にはapplication/jsonを指定
service_id path string 必須 配信設定を表すservice_id
status query string 任意 更新後のステータス
省略時は更新しません。
- activate:コンテンツ配信有効
- deactivate:コンテンツ配信無効
container query string 任意 アクセスログの格納先を表すオブジェクトストレージのコンテナ
省略時は更新しません。
object_prefixの省略時は、以前に指定した値が使用されます。
- 格納先を表す文字列：アクセスログの格納先を変更する
- 空文字列：アクセスログを停止する
object_prefix query string 任意 アクセスログのオブジェクト名を表すプレフィックス
疑似パス情報を含めることも可能です。省略時は更新しません。
例) "path/PRE01_", "PRE01_"等
key_container query string 任意 アクセスログの暗号化に使用するための公開鍵が格納された、オブジェクトストレージのコンテナ
- コンテナ名を表す文字列：指定コンテナを参照する
- 空文字列：上記container値を使用する(default)
key_object query string 任意 アクセスログの暗号化に使用するための公開鍵のオブジェクト名
疑似パス情報を含めることも可能です。公開鍵のオブジェクトは事前に格納しておく必要があります。
- オブジェクト名を表す文字列：アクセスログを暗号化する
- 空文字列：アクセスログを暗号化しない(default)
例) "public_key"
rules body string 任意 キャッシュ動作制御ルール
詳細はAppendix.A キャッシュ動作制御ルールを参照してください。

レスポンスボディ（正常系）の説明#

名前 Type Description
Content-Length string ヘッダーを除いたリクエスト長(Byte)
Content-Type string コンテントタイプ
- application/json：レスポンスボディがJSON形式の場合
Date string レスポンスの日時
X-Message string ステータスの補足情報
- Success: 成功しました
- No services to return: 配信設定なし(空のリスト)
- No Content: 返せる内容がありません
- Accepted: 要求は受け付けられました
- Bad Request: 要求が正しくありません
- Invalid entry for xxx: xxxの値が正しくありません
- Invalid Json: Jsonフォーマットが正しくありません
- Quota exceeded: 作成可能な上限を超えています
- Service is in progress: 他の処理が進行中です
- Service is undeployed: 配信設定が無効状態です
- Parameter required: パラメーターが必要です
- Rate limit exceeded: 要求が多すぎるため、しばらく経ってから実行してください
- Internal Server Error: 内部エラーです
- Service Unavailable: 一時的に利用できません
X-Error string エラー時の詳細情報
- Invalid JSON input / <エラー内容>
JSON形式のデータに誤りがあります。詳細は<エラー内容>を参照してください
- Internal Server Error(数字3桁)
その他の内部エラーです。数字3桁部分は、問合せに使用する場合があります。
- Service Unavailable (数字3桁)
その他の一時的なエラーです。数字3桁部分は、問合せに使用する場合があります。
X-Error-Instance-ID string エラーが発生したコマンドの情報
問合せに使用する場合があります。
X-Status string ステータス情報
配信設定の場合：
- create_in_progress - 作成処理中
- deployed - 配信完了し、利用可能
- undeployed - 配信停止中
- update_in_progress - 更新処理中
- delete_in_progress - 削除処理中
- failed - 処理が失敗しました。X-Errorを参照ください
レポートの場合：
- create_in_progress - 作成処理中
- deployed - レポート作成完了し、利用可能
- failed - 処理が失敗しました。X-Errorを参照ください
X-Access-Log-Status string ステータス情報
- deployed - 配信完了し、利用可能
- undeployed - 配信停止中
- failed - 処理が失敗しました。X-Access-Log-Status-Detailedを参照して下さい。
X-Access-URL string 配信FQDN
独自ドメインまたは付与ドメインです。
X-Protocol string 配信プロトコルスキーム
httpまたはhttpsです。
Location string service_id, report_idを含むURL
X-Access-Log-Container string アクセスログの格納先を示すオブジェクトストレージのコンテナ
X-Access-Log-Object-Prefix string アクセスログのオブジェクト名のプレフィックス
X-Access-Log-Key-Container string アクセスログの暗号化に使用するための公開鍵が格納された、オブジェクトストレージのコンテナ
X-Access-Log-Key-Object string アクセスログの暗号化に使用するための公開鍵のオブジェクト名
X-Access-Log-Detailed-Status string アクセスログでエラーがあった場合の補足情報
- Access error to the container. - コンテナへのアクセス異常
- Access error to the public key. - 公開鍵格納コンテナおよび公開鍵オブジェクトへのアクセス異常
- Illegal public key. - 公開鍵オブジェクトが不正
- Internal server error. - 内部エラー発生

レスポンス例#

       PATCH /v1/services/service_id-25/param?status=activate&container=log&object_prefix=acclog&key_container=keys&key_object=public_key
       Content-type:application/json
       Content-Length: 375
       
       (BODY略)
       
       HTTP/1.1 202 Accepted
       X-Message: Accepted
       Location: http://<Endpoint>/v1/services/service_id-25
       Content-Length: 0