Introduction

() is a cloud-native platform where most functionalities are implemented through Kubernetes operators. The API Reference documentation provides comprehensive information about the APIs available in .

Types of APIs

offers two types of APIs:

Kubernetes APIs

Most capabilities are exposed through Kubernetes APIs. These APIs are accessible using standard Kubernetes clients such as kubectl, client-go, and others. For a complete list of these APIs, refer to the Kubernetes APIs section.

For information on how to call these APIs, including standard patterns and examples, please refer to the Kubernetes API Usage Guide.

Advanced APIs

Some functionalities, such as log querying, are not suitable for exposure through Kubernetes APIs. For these cases, provides RESTful APIs that can be accessed via HTTP requests. For a complete list of these APIs, refer to the Advanced APIs section.

API Authentication

Both Kubernetes APIs and Advanced APIs use user token for authentication and authorization. You only need to add the token to the Authorization header in your HTTP request:

curl -X GET "http://<acp-api-server-address>/apis/v1/namespaces/default/pods" \
     -H "Authorization: Bearer <your-token>"

Obtaining an User Token

To obtain an user token, follow these steps:

  1. Log in to the Web Console, click on your username in the top-right corner to expand the dropdown menu, and click on the Profile menu item to access the personal center page.

  2. On the personal center page, click on the API Tokens tab, and click the Add API Token button to create a new token.

  3. In the pop-up dialog, enter a description for the token and set an expiration time, then click the Add button to create the token.

  4. After successful creation, the system will generate a token and display it on the page.

  5. Copy the token to the clipboard and save it securely for future use when calling ACP APIs.