Querying a Multi-cloud Cluster

Function

This API is used to query multi-cloud clusters.

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, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/container/kubernetes/multi-cloud/clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
cluster_id	No	String	Cluster ID
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total clusters
data_list	Array of MultiCloudClusterInfo objects	Multi-cloud cluster information list

**Table 5** MultiCloudClusterInfo
Parameter	Type	Description
cluster_id	String	Cluster ID
cluster_name	String	Cluster Name
provider	String	Service provider
server	String	API server address of a cluster
image_repo	String	Image repository address
status	String	Definition Connection status of ANP-Agent Range not_connect: not connected connect_success: connected connect_fail: Connection failed. connect_disruption: Connection interrupted.
version	String	ANP-Agent version
current_expiration_date	Long	End time of the current validity period
certificate_expiration_date	Long	End time of the certificate validity period

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "cluster_id" : "b075094b-d21a-499a-9006-624089c94402",
    "cluster_name" : "ywk-55555",
    "provider" : "self_built_hw",
    "server" : "https://lb.kubesphere.local:6443",
    "image_repo" : "swr.cn-north-7.myhuaweicloud.com",
    "status" : "not_connect",
    "version" : "0.0.2",
    "current_expiration_date" : 1814080859608,
    "certificate_expiration_date" : 1814080859608
  } ]
}