Help Center/ Application Service Mesh/ API Reference/ API/ Mesh APIs/ Obtaining Available Clusters
Updated on 2026-06-25 GMT+08:00

Obtaining Available Clusters

Function

This API is used to obtain all clusters for creating a Basic mesh.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    asm:mesh:getAvailableClusters

    Read

    -

    -

    -

    -

URI

GET /v3/projects/{project_id}/clusters-to-be-added

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

items

Array of objects

For details, see Listing Clusters in a Specified Project.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

errorCode

String

Error code

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The cluster list is obtained.

500

Internal error.

Error Codes

See Error Codes.