Get Service Details

This API is used to retrieve details of a specific website cceleration service.

Request

Request-Line

GET /cdn/v1.0/service/{serviceId} HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
serviceId	Integer	Mandatory	The unique identifier of the service.

Response

Response Body

Property name	Type	Description
id	Integer	Service ID number.
domainName	String	Primary domain name for the acceleration.
origins	Array	List of origin servers. At least one origin is required. For multiple origins, the order determines the priority (the first one is primary, subsequent ones are fallbacks). See Origin for details.
defaultHostHeader	String	Specifies the default host header and SNI when no explicit host header or SNI is configured. preserve: Maintains the host header and SNI from the original request. originHost: Uses the host from the origin URL.
alternateDomainNames	Array	List of alternate domain names for the service.
streaming	Boolean	Whether to combine multiple client requests to a single request to the origin server. true: Enabled, false: Disabled. Default is false.
http2	Boolean	Enable HTTP/2 protocol. Default is true.
http3	Boolean	Enable HTTP/3 protocol. Default is false.
redirectHttpToHttps	Boolean	Whether to redirect all HTTP requests to HTTPS. Default is false.
tlsProfile	String	TLS security profile. modern: TLS 1.3 only, highest security, no backward compatibility. intermediate: Recommended for most services, compatible with modern clients. old: Maximum compatibility, use only for legacy client support.
enabled	Boolean	Whether the service is enabled. Default is true.

Object: Origin

Property name	Type	Description
originUrl	String	Origin service address. Format: [http[s]://]hostname[:port][/path/prefix]. If scheme is specified, it is forced for all origin requests. If omitted, the client's protocol is used.
sni	String	The server name to send to the origin during SSL handshake.
headers	Object	The Origin Headers containing extra headers to send to the origin.
s3Credential	Object	Configure the S3 credential. See S3Credential for details.

Object: S3 Credential

Property name	Type	Description
accessKey	String	Configure the AWS access key ID to generate the signature to access S3.
accessSecret	String	Configure the AWS access secret to generate the signature to access S3.
region	String	Configure the AWS region (e.g., ap-southeast-1).
dropQueryString	Boolean	Drop the query string from the origin generating the signature to it. Default is false.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	InvalidService.IdIncorrect	Service ID is invalid.

Examples

GET Service Detail

Request

GET /cdn/v1.0/services/228622 HTTP/1.1

Successful Response Body

{
  "id": 228622,
  "domainName": "test.example.com",
  "streaming": true,
  "http2": true,
  "http3": false,
  "redirectHttpToHttps": true,
  "enabled": true,
  "tlsProfile": "modern",
  "origins": [
    {
      "originUrl": "https://origin1.example.com",
      "sni": "origin-sni.example.com",
      "headers": {
        "X-Custom-Header": "test-value",
        "X-Forwarded-For": "client-ip"
      },
      "s3Credential": {
        "accessKey": "AKIAEXAMPLE123456",
        "accessSecret": "secret1234567890abcdefghijklmnopqrstuvwxyz",
        "region": "us-east-1",
        "dropQueryString": false
      }
    }
  ],
  "defaultHostHeader": "originHost",
  "alternateDomainNames": [
    "cdn.example.com",
    "www.test.example.com"
  ],
  "cName": "edge2x.testing.veloceed.com"
}