All Products
Search
Document Center

Microservices Engine:QueryGovernanceKubernetesCluster

Last Updated:Aug 12, 2024

Queries the Kubernetes clusters for which Microservices Governance is activated.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:QueryGovernanceKubernetesClusterget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterNamestringYes

The name of the Kubernetes cluster.

example-cluster
ClusterIdstringYes

The ID of the Kubernetes cluster.

c24c9354acxxxxxxx
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

10
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Messagestring

The returned message.

success
RequestIdstring

The ID of the request.

DE34D413-2B79-5E77-9696-36D875E822AD
Dataobject

The data returned.

Resultarray<object>

The details of the data.

object

The data structure.

ClusterNamestring

The name of the cluster.

example-cluster
ClusterIdstring

The ID of the cluster.

abcdef123456789
Regionstring

The region where the cluster resides.

cn-shanghai
K8sVersionstring

The version of the cluster.

1.22
NamespaceInfosstring

The information about the namespace.

[{"Name":"ack-onepilot","Tags":{"name":"ack-onepilot"}}]
PilotStartTimestring

The time when the pilot component was started.

2022-05-17T05:39:43.000+0000
TotalSizeinteger

The total number of clusters.

3
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "DE34D413-2B79-5E77-9696-36D875E822AD",
  "Data": {
    "Result": [
      {
        "ClusterName": "example-cluster",
        "ClusterId": "abcdef123456789",
        "Region": "cn-shanghai",
        "K8sVersion": "1.22",
        "NamespaceInfos": "[{\"Name\":\"ack-onepilot\",\"Tags\":{\"name\":\"ack-onepilot\"}}]",
        "PilotStartTime": "2022-05-17T05:39:43.000+0000"
      }
    ],
    "TotalSize": 3,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-05-10The Error code has changed. The response structure of the API has changedView Change Details