List all services

お客様のプロジェクトで操作可能な配信設定の一覧を取得します。

APIエンドポイント

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

HTTPメソッドとURI

GET

/v1/services

HTTPステータスコード

正常時：200

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

名前	In	Type	デフォルト値 /必須指定	Description
X-Auth-Token	header	string	必須	ユーザー認証を行った際に取得するトークン
Content-Type	header	string	任意	リクエストボディで指定する情報がJSON形式の場合にはapplication/jsonを指定

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

名前	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. - 内部エラー発生
services	string	配信設定 undeployed状態のアイテムも応答に含めます。
id	string	配信設定を表すservice_id
status	string	ステータス情報 X-Statusレスポンスヘッダーを参照してください。
access-log-status	string	ステータス情報 X-Access-Log-Statusレスポンスヘッダーを参照してください。
links	string	子要素のコンテナ
href	string	配信FQDN X-Access-URLを参照してください。
rel	string	service_idを含むURL Locationヘッダーを参照してください。

レスポンス例

2つの場合

   GET /v1/services
       
   HTTP/1.1 200 OK
   X-Message: Success
   Content-Type: application/json
   Content-Length: 442
   {
        "services": [
         {
          "access_log_status": "undeployed",
          "id": "36adedf4-2370-476c-b531-3913b9502fe7",
          "links": {
           "href": "ct.list.00002.net",
           "rel": "https://<Endpoint>/v1/services/36adedf4-2370-476c-b531-3913b9502fe7"
          },
          "status": "deployed"
         },
         {
          "access_log_status": "undeployed",
          "id": "a71170d3-b95e-4182-9918-687e327792bf",
          "links": {
           "href": "ct.list.00003.net",
           "rel": "https://<Endpoint>/v1/services/a71170d3-b95e-4182-9918-687e327792bf"
          },
          "status": "deployed"
         }
        ]
   }

空の場合

   GET /v1/services
           
   HTTP/1.1 200 OK
   Date: Fri, 30 Oct 2015 00:11:44 GMT
   X-Message: No services to return
   Content-Type: application/json
   Content-Length: 16
   {
        "services": []
   }