List Redirection

This API is used to list redirection policy for website accleration service.

Request

Request-Line

GET /cdn/v1.0/services/{serviceId}/redirections HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
serviceId	Integer	Mandatory	Service id.

Response

Response Body

Parameter	Type	Description
	Array	Array of Redirection.

Object: Redirection

Parameter	Type	Description
policyId	Integer	Policy ID number for redirection.
policyName	String	Policy name for redirection.
matchUrlPath	Object	URL path matching configuration that determines which requests the rule applies to. See Match Url Path for details.
redirectDestination	String	Send an HTTP redirect if this policy matches.
httpCode	Integer	HTTP response code to use if sending an HTTP redirect. Could be "301/302".
matchQueryString	Object	Query-string matching configuration used to refine which requests the rule applies to. See Match Query String for details.
priority	Integer	Priority weight for the rule. Rules with a higher weight take precedence. The weight must be non-zero.
enabled	Boolean	Flag defining if policy is active or no. Default is true.

Object: Match Url Path

Parameter	Type	Description
operator	String	Defines how to match the field. Supported values:prefix,regex,equals,suffix.
patterns	String[]	List of patterns matching the URL path string.

Object: Match Query String

Parameter	Type	Description
operator	String	Defines how to match the field. Supported values:prefix,regex,equals,suffix.
patterns	String[]	List of patterns matching the URL query string.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	Request.BadRequest	Bad request.
400	InvalidCustomer.IdEmpty	Customer id can be empty or invalid.
400	InvalidService.IdIncorrect	Service id is empty or invalid.
400	ServiceId.IdPermission	ServiceId can not be found or unknown.

Examples

List Redirection

Request

GET /cdn/v1.0/services/228657/redirections HTTP/1.1

Successful Response Body

[
    {
        "policyId": 261885,
        "policyName": "redirectionInfo",
        "redirectDestination": "www.example.com",
        "httpCode": 301,
        "matchUrlPath": {
            "operator": "prefix",
            "patterns": [
                "/"
            ]
        },
        "priority": 333,
        "enabled": true
    },
    {
        "policyId": 261887,
        "policyName": "redirection",
        "redirectDestination": "www.example.com",
        "httpCode": 301,
        "matchUrlPath": {
            "operator": "prefix",
            "patterns": [
                "/"
            ]
        },
        "priority": 333,
        "enabled": true
    },
    {
        "policyId": 261888,
        "policyName": "resu",
        "redirectDestination": "www.example.com",
        "httpCode": 301,
        "matchUrlPath": {
            "operator": "prefix",
            "patterns": [
                "/"
            ]
        },
        "priority": 333,
        "enabled": true
    },
    {
        "policyId": 261957,
        "policyName": "redoxxx",
        "redirectDestination": "www.domainmm.com",
        "httpCode": 302,
        "matchUrlPath": {
            "operator": "suffix",
            "patterns": [
                "/"
            ]
        },
        "priority": 1,
        "enabled": true
    },
    {
        "policyId": 261953,
        "policyName": "redo",
        "redirectDestination": "www.domain333.com",
        "httpCode": 302,
        "matchUrlPath": {
            "operator": "prefix",
            "patterns": [
                "/"
            ]
        },
        "priority": 1,
        "enabled": true
    }
]