Cloud Native Compiler API

Table of Contents

Profile Log Service Admin API

Need help?

Schedule a consultation with an Azul performance expert.

Cloud Native Compiler provides an administration API with the following methods.

Profile Log Service Admin API

These methods are available on <GATEWAY_IP>:<SERVICE_PORT>/pls/… and can be accessed without authentication. The service port typically is 8080, but can be different based on the used configuration.

Method Url Description

GET

/pls/names

Returns a list of all profile names with summary information.

GET

/pls/names/{name}

Returns summary information for the requested profile name.

DELETE

/pls/names/{name}

Deletes given profile name and all profiles belonging to it.

GET

/pls/names/{name}/profiles

Returns summary information for all of the profiles within a given profile name. Use the ?status=promoted query parameter to see only the promoted profile.

GET

/pls/names/{name}/profiles/{Id}

Returns summary information for a specific profile.

DELETE

/pls/names/{name}/profiles/{Id}

Deletes a specific profile.

GET

/pls/names/{name}/export

Exports all of the profiles in a specific profile name. Each profile’s directory has the Id of the VM that created it. The promoted profile, meaning the profile that PLS sends to new clients requesting the profile name, is stored in profilePromoted.json. The README has instructions for unifying the profile chunks into a single profile file that can be used as a local input to ReadyNow. You can see the iteration of a given profile in the profileIteration property in the profile’s profileInfo.json file.

Note	The profile export fails if the resulting data stream is larger than 2GB. If this happens, consider just exporting the promoted profile using the `?status=promoted` query parameter.

POST

/pls/names/{name}/import

Imports a profile log to this instance of Cloud Native Compiler. This API is mostly used for moving a promoted profile from one CNC instance to another. The uploaded file should be a zip archive in the format produced by the /profile/export API. Do not rename directories in the profile structure or edit the profile metadata.

Note	If the profile name already exists, the import fails.

GET

/pls/statistics

Returns service-wide statistics for this instance of Cloud Native Compiler.