Skip to content

How to use Cloudlets

Handles Cloudlet API requests.

Source code in akapy/cloudlets/cloudlet.py 
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
class Cloudlet:
    """Handles Cloudlet API requests."""

    def __init__(self, auth=None) -> None:
        """
        Initialize Cloudlet API client.

        Args:
            auth: Auth object for handling credentials. Will use default if not provided.
        """
        if auth is None:
            self.auth = Auth()
        else:
            self.auth = auth

        self.endpoint = "cloudlets/api/v2"
        self.requester = Requester(self.auth.get_session(), self.auth.host_url)
        self.cloudlet_types = {
            0: {"name": "Edge Redirector", "abbreviation": "ER"},
            1: {"name": "Visitor Prioritization", "abbreviation": "VP"},
            3: {"name": "Forward Rewrite", "abbreviation": "FR"},
            4: {"name": "Request Control", "abbreviation": "RC"},
            5: {"name": "API Prioritization", "abbreviation": "AP"},
            6: {"name": "Audience Segmentation", "abbreviation": "AS"},
            7: {"name": "Phased Release", "abbreviation": "PR"},
            9: {"name": "Application Load Balancer", "abbreviation": "ALB"},
        }

    def _get_cloudlet_id(self, cloudlet_id: Union[int, str]) -> Union[int, None]:
        """Converts a cloudlet ID to an integer.

        Args:
            cloudlet_id (Union[int, str]): The cloudlet ID, either as an integer
                or a string name/abbreviation.

        Returns:
            int: The integer cloudlet ID.

        This handles looking up the integer ID from the name/abbreviation
        if a string is provided.
        """
        cloudlet_type_int = None
        if isinstance(cloudlet_id, int):
            cloudlet_type_int = cloudlet_id
        else:
            for k, v in self.cloudlet_types.items():
                if cloudlet_id in (v["name"], v["abbreviation"]):
                    cloudlet_type_int = k
                    break
        return cloudlet_type_int

    def get_all(self) -> List[Dict]:
        """Gets information on all cloudlets.

        Makes a GET request to the /cloudlet-info endpoint to retrieve 
        a list of dictionaries containing information on all available cloudlets.

        Returns:
            List[Dict]: A list of dictionaries containing information on all cloudlets.
        """
        return self.requester(method="GET", endpoint=f"{self.endpoint}/cloudlet-info")

    def by_type(self, cloudlet_id: Union[int, str]) -> List[Dict]:
        """Get cloudlet type information.

        Args:
            cloudlet_id (Union[int, str]): The cloudlet type identifier, 
                either as an integer or a name/abbreviation string.
                Cloudlet type options:
                    0: "Edge Redirector" (ER)
                    1: "Visitor Prioritization" (VP)
                    3: "Forward Rewrite" (FR)
                    4: "Request Control" (RC)
                    5: "API Prioritization" (AP)
                    6: "Audience Segmentation" (AS)
                    7: "Phased Release" (PR)
                    9: "Application Load Balancer" (ALB)

        Returns:
            List[Dict]: List of dictionaries containing the cloudlet type information.

        This function handles looking up the cloudlet type integer ID
        from the name or abbreviation string if provided.
        It constructs the API endpoint using this integer ID and makes the request.
        """

        return self.requester(
            method="GET", endpoint=f"{self.endpoint}/{self._get_cloudlet_id(cloudlet_id)}"
        )

    def list_groups(self) -> List[Dict]:
        """
        List all groups available to the user.

        Makes a GET request to the groups endpoint to retrieve a
        list containing information about the groups.

        Returns:
            List[Dict]: List containing the group information dicts.
        """
        return self.requester(endpoint=f"{self.endpoint}/group-info", method="GET")

    def list_policies(
        self, 
        is_deleted: bool = False, 
        cloudlet_id: Union[int, str, None] = None
    ) -> List[Dict]:
        """
        List policies filtered by deleted status and cloudlet ID.

        Args:
            is_deleted: Whether to include deleted policies.
            cloudlet_id: Optional cloudlet ID to filter by. Can pass:
                - Integer cloudlet ID
                - String abbreviation (e.g. "ER") 
                - Full cloudlet name (e.g. "Edge Redirector")

        Returns: 
            List of dictionaries containing policy information.
        """
        params = f"?includeDeleted={is_deleted}"
        if cloudlet_id is not None:
            params += f"&cloudletId={self._get_cloudlet_id(cloudlet_id)}"

        return self.requester(
            endpoint=f"{self.endpoint}/policies{params}", 
            method="GET"
        )

__init__(auth=None)

Initialize Cloudlet API client.

Parameters:

Name Type Description Default
auth

Auth object for handling credentials. Will use default if not provided.

 None
Source code in akapy/cloudlets/cloudlet.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def __init__(self, auth=None) -> None:
    """
    Initialize Cloudlet API client.

    Args:
        auth: Auth object for handling credentials. Will use default if not provided.
    """
    if auth is None:
        self.auth = Auth()
    else:
        self.auth = auth

    self.endpoint = "cloudlets/api/v2"
    self.requester = Requester(self.auth.get_session(), self.auth.host_url)
    self.cloudlet_types = {
        0: {"name": "Edge Redirector", "abbreviation": "ER"},
        1: {"name": "Visitor Prioritization", "abbreviation": "VP"},
        3: {"name": "Forward Rewrite", "abbreviation": "FR"},
        4: {"name": "Request Control", "abbreviation": "RC"},
        5: {"name": "API Prioritization", "abbreviation": "AP"},
        6: {"name": "Audience Segmentation", "abbreviation": "AS"},
        7: {"name": "Phased Release", "abbreviation": "PR"},
        9: {"name": "Application Load Balancer", "abbreviation": "ALB"},
    }

by_type(cloudlet_id)

Get cloudlet type information.

Parameters:

Name Type Description Default
cloudlet_id Union[int, str]

The cloudlet type identifier, either as an integer or a name/abbreviation string. Cloudlet type options: 0: "Edge Redirector" (ER) 1: "Visitor Prioritization" (VP) 3: "Forward Rewrite" (FR) 4: "Request Control" (RC) 5: "API Prioritization" (AP) 6: "Audience Segmentation" (AS) 7: "Phased Release" (PR) 9: "Application Load Balancer" (ALB)

 required

Returns:

Type Description
List[Dict]

List[Dict]: List of dictionaries containing the cloudlet type information.

This function handles looking up the cloudlet type integer ID from the name or abbreviation string if provided. It constructs the API endpoint using this integer ID and makes the request.

Source code in akapy/cloudlets/cloudlet.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def by_type(self, cloudlet_id: Union[int, str]) -> List[Dict]:
    """Get cloudlet type information.

    Args:
        cloudlet_id (Union[int, str]): The cloudlet type identifier, 
            either as an integer or a name/abbreviation string.
            Cloudlet type options:
                0: "Edge Redirector" (ER)
                1: "Visitor Prioritization" (VP)
                3: "Forward Rewrite" (FR)
                4: "Request Control" (RC)
                5: "API Prioritization" (AP)
                6: "Audience Segmentation" (AS)
                7: "Phased Release" (PR)
                9: "Application Load Balancer" (ALB)

    Returns:
        List[Dict]: List of dictionaries containing the cloudlet type information.

    This function handles looking up the cloudlet type integer ID
    from the name or abbreviation string if provided.
    It constructs the API endpoint using this integer ID and makes the request.
    """

    return self.requester(
        method="GET", endpoint=f"{self.endpoint}/{self._get_cloudlet_id(cloudlet_id)}"
    )

get_all()

Gets information on all cloudlets.

Makes a GET request to the /cloudlet-info endpoint to retrieve a list of dictionaries containing information on all available cloudlets.

Returns:

Type Description
List[Dict]

List[Dict]: A list of dictionaries containing information on all cloudlets.
Source code in akapy/cloudlets/cloudlet.py 
57
58
59
60
61
62
63
64
65
66
def get_all(self) -> List[Dict]:
    """Gets information on all cloudlets.

    Makes a GET request to the /cloudlet-info endpoint to retrieve 
    a list of dictionaries containing information on all available cloudlets.

    Returns:
        List[Dict]: A list of dictionaries containing information on all cloudlets.
    """
    return self.requester(method="GET", endpoint=f"{self.endpoint}/cloudlet-info")

list_groups()

List all groups available to the user.

Makes a GET request to the groups endpoint to retrieve a list containing information about the groups.

Returns:

Type Description
List[Dict]

List[Dict]: List containing the group information dicts.
Source code in akapy/cloudlets/cloudlet.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
def list_groups(self) -> List[Dict]:
    """
    List all groups available to the user.

    Makes a GET request to the groups endpoint to retrieve a
    list containing information about the groups.

    Returns:
        List[Dict]: List containing the group information dicts.
    """
    return self.requester(endpoint=f"{self.endpoint}/group-info", method="GET")

list_policies(is_deleted=False, cloudlet_id=None)

List policies filtered by deleted status and cloudlet ID.

Parameters:

Name Type Description Default
is_deleted bool

Whether to include deleted policies.

 False
cloudlet_id Union[int, str, None]

Optional cloudlet ID to filter by. Can pass: - Integer cloudlet ID - String abbreviation (e.g. "ER") - Full cloudlet name (e.g. "Edge Redirector")

 None

Returns:

Type Description
List[Dict]

List of dictionaries containing policy information.
Source code in akapy/cloudlets/cloudlet.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def list_policies(
    self, 
    is_deleted: bool = False, 
    cloudlet_id: Union[int, str, None] = None
) -> List[Dict]:
    """
    List policies filtered by deleted status and cloudlet ID.

    Args:
        is_deleted: Whether to include deleted policies.
        cloudlet_id: Optional cloudlet ID to filter by. Can pass:
            - Integer cloudlet ID
            - String abbreviation (e.g. "ER") 
            - Full cloudlet name (e.g. "Edge Redirector")

    Returns: 
        List of dictionaries containing policy information.
    """
    params = f"?includeDeleted={is_deleted}"
    if cloudlet_id is not None:
        params += f"&cloudletId={self._get_cloudlet_id(cloudlet_id)}"

    return self.requester(
        endpoint=f"{self.endpoint}/policies{params}", 
        method="GET"
    )

Example Code

import akapy as ak

c = akapy.Cloudlet()

print(c.get_all())

Return

[
  {
    "serviceVersion": null,
    "apiVersion": "2.0",
    "location": "/cloudlets/api/v2/cloudlet-info/3",
    "cloudletId": 3,
    "cloudletCode": "FR",
    "cloudletName": "FORWARDREWRITE"
  },
  {
    "serviceVersion": null,
    "apiVersion": "2.0",
    "location": "/cloudlets/api/v2/cloudlet-info/0",
    "cloudletId": 0,
    "cloudletCode": "ER",
    "cloudletName": "EDGEREDIRECTOR"
  }
]