Retrieve a service#
service_idで指定する配信設定を取得します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://cdn.gls.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://cdn.gls.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v1/services/{service_id}
HTTPステータスコード#
正常時:200, 204
前回の要求に対してエラーが生じている場合は、X-Statusレスポンスヘッダーがfailedなので、X-Errorのレスポンスヘッダーも参照してください。
前回の要求に対してエラーが生じている場合でも、既存の配信設定を応答可能な場合は、ステータスコード200を応答し、レスポンスボディにキャッシュ動作制御ルール、レスポンスヘッダーに各設定値が格納されます。
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
X-Auth-Token | header | string | 必須 | ユーザー認証を行った際に取得するトークン |
Content-Type | header | string | 任意 | リクエストボディで指定する情報がJSON形式の場合にはapplication/jsonを指定 |
service_id | path | string | 必須 | 配信設定を表すservice_id |
レスポンスボディ(正常系)の説明#
名前 | 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 - 処理が失敗しました。-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. - 内部エラー発生 |
rules | string | キャッシュ動作制御ルール 詳細はAppendix.A キャッシュ動作制御ルールを参照してください。 |
レスポンス例#
GET /v1/services/f460e5a4-4550-4f3b-b9ab-8ec6794bda0a HTTP/1.1 200 OK X-Message: Success X-Status: deployed X-Access-Url: test-cccbfc24.cdn-edge.cloud.global.fujitsu.com X-Protocol: http X-Access-Log-Status: undeployed X-Access-Log-Container: X-Access-Log-Object-Prefix: X-Access-Log-Key-Container: X-Access-Log-Key-Object: X-Access-Log-Detailed-Status: Content-type: application/json Content-Length: 429 { "rules": [ { "matches": [ { "name": "url-wildcard", "value": "/*" } ], "behaviors": [ { "params": { "cacheKeyValue": "-", "digitalProperty": "test-cccbfc24.cdn-edge.cloud.global.fujitsu.com", "cacheKeyType": "origin", "hostHeaderValue": "-", "originDomain": "jp.fujitsu.com", "hostHeaderType": "origin" }, "name": "origin", "value": "-" }, { "type": "fixed", "name": "caching", "value": "1d" } ] } ] }