Common API response headers

Response Headers

Content-Length

Request length excluding the header (in bytes)

Data Type Cardinality
String 1..1

Content-Type

Type of contents

  • application/json: The response body is using JSON format

Date

Datetime of the response

Data Type Cardinality
String 1..1

X-Message

Supplementary information about the status
  • Success: Completed successfully
  • No services to return: No services (empty list)
  • No Content: There is no content to return
  • Accepted: Request was received
  • Bad Request: The request was invalid
  • Invalid entry for xxx: The value of xxx is invalid
  • Invalid Json: Invalid JSON format
  • Quota exceeded: The maximum number that can be created is exceeded
  • Service is in progress: Another process is in progress
  • Service is undeployed: The service is disabled
  • Parameter required: A parameter is required
  • Rate limit exceeded: Too many requests. Wait for a few moments, and then execute again
  • Internal Server Error: Internal error
  • Service Unavailable: The service is temporarily unavailable
Data Type Cardinality
String 0..1

X-Error

Error details
  • Invalid JSON input / <errorContent>

    There is an error in the JSON-formatted data. Refer to <errorContent> for details

  • Internal Server Error (3DigitNumber)

    Other internal error. The 3DigitNumber portion may be used for inquiries.

  • Service Unavailable (3DigitNumber)

    Other temporary error. The 3DigitNumber portion may be used for inquiries.

Data Type Cardinality
String 0..1

X-Error-Instance-ID

Information on the command for which the error occurred. May be used for inquiries

Data Type Cardinality
String 0..1

X-Status

Status information

Service status:
  • create_in_progress - Creation in progress
  • deployed - Deployment is complete and is ready for use
  • undeployed - Deployment is stopped
  • update_in_progress - Update in progress
  • delete_in_progress _ Deletion in progress
  • failed - Processing failed. Refer to X-Error
Report:
  • create_in_progress - Creation in progress
  • deployed - Report has been created and is ready for use
  • failed - Processing failed. Refer to X-Error
Data Type Cardinality
String 0..1

X-Access-Log-Status

Status information
  • deployed - Deployment is complete and is ready for use
  • undeployed - Deployment is stopped
  • failed - Processing failed. Refer to X-Access-Log-Status-Detailed.
Data Type Cardinality
String 0..1

X-Access-URL

Service FQDN. your own domain name or cdn-edge domain name

Data Type Cardinality
String 1..1

X-Protocol

Delivery protocol scheme. http or https

Data Type Cardinality
String 1..1

Location

URL including service_id and report_id

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