Retrieve a service (GET /v1/services/{service_id})

Lists information about the specified service.

The table below lists the main status codes and X-Message header values.

Status code X-Message header
200 Success: Completed successfully
204 No Content: There is no content to return
204 Bad Request: The request was invalid
204 Internal Server Error: Internal error
204 Service Unavailable: The service is temporarily unavailable

If an error has occurred for the previous request, the X-Status response header will be "failed", so refer to the X-Error response header.

If the existing service can be used to respond even when an error has occurred for the previous request, the status code 200 will be returned, the caching behavior control rule will be inserted into the response body, and each setting value will be stored in the response header.

Request Headers

Refer to "Common API request headers".

Request parameters

service_id

service_id.

Data Type Cardinality
String 1..1

Request Elements

None.

Response Headers

Refer to "Common API response headers".

X-Error

Error details

Data Type Cardinality
String 0..1

X-Error-Instance-ID

Information on the command for which the error occurred

Data Type Cardinality
String 0..1

X-Status

Status information

Data Type Cardinality
String 1..1

X-Access-Log-Status

Status information

Data Type Cardinality
String 1..1

X-Access-URL

Delivery FQDN

Data Type Cardinality
String 1..1

X-Protocol

Delivery protocol scheme

Data Type Cardinality
String 1..1

X-Access-Log-Container

Container of object storage where the access logs are stored

Data Type Cardinality
String 1..1

X-Access-Log-Object-Prefix

Prefix of the access log object name

Data Type Cardinality
String 1..1

X-Access-Log-Key-Container

The container for the object storage where the public key used for encrypting access logs is stored

Data Type Cardinality
String 1..1

X-Access-Log-Key-Object

The object name of the public key used for encrypting access logs

Data Type Cardinality
String 1..1

X-Access-Log-Detailed-Status

Supplementary information in the access log when an error occurs
  • Access error to the container. - An error occurred while accessing the container
  • Access error to the public key. - An error occurred while accessing the public key container and the public key object
  • Illegal public key. - The public key object is illegal
  • Internal server error. - An internal error occurred
Data Type Cardinality
String 1..1

Response Elements

rules

Caching behavior control rules. Refer to "Appendix A Caching Rules" for details.

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None Refer to JSON schema for details on the rules.

Example of response


       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"
               }
             ]
           }
         ]
       }