配信設定一覧の取得(GET /v1/services)
お客様のプロジェクトで操作可能な配信設定の一覧を取得します。配信設定毎の詳細な情報を確認したい場合は、一覧に含まれるservice_idを使用し、配信設定の取得APIを実行して下さい。
undeployed状態のアイテムも応答に含めます。
主なステータスコードとX-Message ヘッダーの値を示します。
ステータスコード | X-Message ヘッダー |
---|---|
200 | Success:成功しました |
200 | No services to return:配信設定なし(空のリスト) |
Request Headers
API共通リクエストヘッダーを参照。
Request Parameter
特にありません。
Response Headers
API共通レスポンスヘッダーを参照。
Response Elements
services
配信設定
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..n | None | id, status, links |
id
配信設定を表すservice_id
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | services | None |
status
ステータス情報。X-Statusレスポンスヘッダーを参照ください
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | services | None |
access-log-status
ステータス情報。X-Access-Log-Statusレスポンスヘッダーを参照ください
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | services | None |
links
子要素のコンテナ
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | services | rel, href |
href
配信FQDN。X-Access-URLを参照ください
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | links | None |
rel
service_idを含むURL。Locationヘッダーを参照ください
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..1 | links | None |
Example of Response
【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": []
}