Help Center> Cloud Container Engine> API Reference> APIs> API URL
View PDF

API URL

  • The URL for cluster management APIs is in the format of https://Endpoint/uri. uri indicates the resource path, that is, the API access path.
  • The URL for Kubernetes APIs, storage management APIs, and add-on management APIs are in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cluster ID, and uri indicates the resource path, that is, the path for API access.
    • The format of the URL called by the add-on management APIs is https://{clusterid}.Endpoint/uri. However, {clusterid} is used only for the domain name and is not verified or used by the APIs. Set {clusterid} in the query or body. For details about {clusterid}, see Add-ons.
    • {clusterid} is required for Kubernetes APIs and Storage Management, which indicates the cluster that needs to be accessed by calling the API.
Table 1 URL parameters

Parameter

Description

{clusterid}

Cluster ID. After a cluster is created, call the API for obtaining a cluster in a specified project to obtain the cluster ID.

Endpoint

URL that is the entry point for a web service. It is obtained from Regions and Endpoints.

uri

Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is v3/auth/tokens.

Calling APIs

Parent topic: APIs