Get cache rule information

Request

Method Request URI
GET https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints/{endpointId}/cacherules?apiVersion=1.0

URI parameter

Parameter name Description
subscriptionId Subscription unique identifier
endpointId Target node unique identifier

Request header

Request header Description
x-azurecdn-request-date Required. Enter the current UTC request time in yyyy-MM-dd hh:mm:ss format.
Authorization Required. Refer to CDN API signing mechanism for authorization headers.

Request body

None

Response

A response comprises a status code, response headers, and a response body.

Status code

Status code Description
200 Indicates that the server has returned a response successfully.
Other General response indicating that an error has occurred.

Response header

Response header Description
X-Correlation-Id The request's unique identifier, which is used to track request information.

Response body

JSON example for request succeeded:

{
  "Rules": [
    {
      "Type": "Dir",
      "Items": [
        "/test1/",
        "/test2/"
      ],
      "TTL": 86400
    },
    {
      "Type": "Suffix",
      "Items": [
        "7z",
        "apk",
        "wdf",
        "cab"
      ],
      "TTL": 2592000
    },
    {
      "Type": "FullUri",
      "Items": [
        "/test1/test.xml",
        "/test2/test.txt"
      ],
      "TTL": 86400
    },
  ],
  "IgnoreCacheControl": false,
  "IgnoreCookie": false,
  "IgnoreQueryString": false
}
Parameter name Description
TTL The cache time, in seconds.
IgnoreCacheControl Indicates whether to ignore the cache-control header in the returned header and cache the request content.
IgnoreCookie Indicates whether to ignore the set-cookie header in the returned header and cache the request content.
IgnoreQueryString Indicates whether to ignore the query parameter and cache the request content.
Type Cache rule type
  • Suffix: Cache based on the file extension
  • Dir: Cache all files in the specified directory
  • FullUri: Cache files at a specific path

JSON example for request failed:

{
  "Succeeded": false,
  "ErrorInfo": {
    "Type": "MissingAuthorizationHeader",
    "Message": "Missing authorization header."
  }
}
Parameter name Description
Type Error type
  • CredentialInvalid: Invalid credentials
  • ParameterMissing: Parameter missing
  • ParameterInvalid: Invalid parameter
  • MissingAuthorizationHeader: Authorization header missing
  • InvalidRequestDateHeader: Invalid request date header
  • MissingRequestDateHeader: Missing request date header
  • AuthorizationHeaderExpired: Authorization header expired
  • InvalidAuthorizationHeader: Invalid authorization header
  • ApiKeyNotFound: API key not found
  • InvalidApiKey: Invalid API key
  • WrongSignature: Wrong signature
  • SubscriptionNotFound: Subscription does not exist
  • EndpointDoesNotBelongToSubscription: Endpoint does not belong to subscription
  • EndpointNotInActiveState: Endpoint not in active state
  • EndpointNotFound: Endpoint does not exist
  • MaliciousItemPathDetected: Malicious item path detected
  • PermissionDenied: Insufficient permissions
  • RequestThrottled: Request throttled
Message Error information
  • Last updated on