Get access control information

  • 12/20/2023

Request

Method Request URI
GET https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints/{endpointId}/accesscontrol?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:

{
  "ForbiddenIps": [
    "192.160.1.1",
    "220.100.100.100"
  ],
  "RefererControl": {
    "Enabled": "true",
    "PathPatterns": [
      "/test1/test1.jpg"
    ],
    "Referers": [
      "http://www.abc.com",
      "http://www.micorosft.com"
    ],
    "RefererControlType": "AllowList"
  }
}
Parameter name Description
ForbiddenIps List of forbidden IPs
PathPatterns [anti-]theft link file path connection
Referers [anti-]theft link connection
RefererControlType Anti-theft chain type
  • AllowList: A whitelist, which allows links for only the matching referrers to access the matching PathPatterns paths.
  • BlockList: A blacklist, with links to matching referrers who will be denied access if they attempt to access the matching PathPatterns paths.

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