配信設定の編集(PATCH /v1/services/{service_id}/param)
service_idで指定する配信設定を編集します。
キャッシュ動作制御ルールを更新する場合、差分ではなく全部を指定する必要があります。また、statusも同時に指定する必要があります。status変更のみの場合は、前回指定したキャッシュ動作制御ルールが使用されます。
主なステータスコードとX-Message ヘッダーの値を示します。
ステータスコード | X-Message ヘッダー |
---|---|
202 | Accepted:要求は受け付けられました |
200 | No services to return:配信設定なし(空のリスト) |
400 | Invalid Json:Jsonフォーマットが正しくありません |
400 | Invalid entry for pre_fqdn/status:値が正しくありません |
400 | Invalid entry for container/object_prefix:値が正しくありません |
400 | Invalid entry for key_container/key_object:値が正しくありません(該当する公開鍵が格納されていない場合) |
400 | Parameter required:パラメーターが必要です。 |
409 | Service is in progress:他の処理が進行中です |
Request Headers
API共通リクエストヘッダーを参照。
Request Parameter
service_id
配信設定を表すservice_id。
Data Type | Cardinality |
---|---|
String | 1..1 |
status
更新後のステータス。 ※省略時は更新しない
- activate:コンテンツ配信有効
- deactivate:コンテンツ配信無効
Data Type | Cardinality |
---|---|
String | 0..1 |
container
アクセスログの格納先を表すオブジェクトストレージのコンテナ ※省略時は更新しない
object_prefixの省略時は、以前に指定した値が使用されます。
- 格納先を表す文字列:アクセスログの格納先を変更する
- 空文字列:アクセスログを停止する
Data Type | Cardinality |
---|---|
String | 0..1 |
object_prefix
アクセスログのオブジェクト名を表すプレフィックス。疑似パス情報を含めても良い。 ※省略時は更新しない
例) "path/PRE01_", "PRE01_"等
Data Type | Cardinality |
---|---|
String | 0..1 |
key_container
アクセスログの暗号化に使用するための公開鍵が格納された、オブジェクトストレージのコンテナ。
- コンテナ名を表す文字列:指定コンテナを参照する
- 空文字列:上記container値を使用する(default)
Data Type | Cardinality |
---|---|
String | 0..1 |
key_object
アクセスログの暗号化に使用するための公開鍵のオブジェクト名。疑似パス情報を含めても良い。公開鍵のオブジェクトは事前に格納しておく必要があります。
- オブジェクト名を表す文字列:アクセスログを暗号化する
- 空文字列:アクセスログを暗号化しない(default)
例) "public_key"
Data Type | Cardinality |
---|---|
String | 0..1 |
Request Elements
rules
キャッシュ動作制御ルール。詳細はAppendix.A キャッシュ動作制御ルールを参照してください。
※省略時は更新しない
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 0..1 | None | ルールのJSONスキーマ 参照 |
Response Headers
API共通レスポンスヘッダーを参照。
Location
service_idを含むURL
Data Type | Cardinality |
---|---|
String | 1..1 |
Response Elements
特にありません。
Example of Response
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