All Products
Search
Document Center

Microservices Engine:GetGovernanceKubernetesCluster

Last Updated:Aug 12, 2024

Queries the information about a Container Service for Kubernetes (ACK) cluster for which Microservices Governance is enabled.

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:GetGovernanceKubernetesClusterget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which the instance resides. The region is supported by MSE.

cn-hangzhou
ClusterIdstringYes

The ID of the instance.

cd23228b3c80c4d4f9ad7af1d87cc****
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Messagestring

The message returned.

success
RequestIdstring

The ID of the request.

5B170A0D-2C5D-4CF8-B808-03966B86****
Dataobject

The details of the data.

ClusterIdstring

The ID of the instance.

cd23228b3c80c4d4f9ad7af1d87cc30d5
ClusterNamestring

The name of the instance.

myCluster
Regionstring

The ID of the region in which the instance resides. The region is supported by MSE.

cn-hangzhou
K8sVersionstring

The version of Kubernetes.

1.20.11-aliyun.1
NamespaceInfosstring

The information of the namespace.

[{\"Name\":\"ack-onepilot\",\"Tags\":null},{\"Name\":\"default\",\"Tags\":{\"mse-enable\":\"enabled\"}},{\"Name\":\"kube-node-lease\",\"Tags\":null},{\"Name\":\"kube-public\",\"Tags\":null},{\"Name\":\"kube-system\",\"Tags\":null}]
PilotStartTimestring

The time when the pilot component was started.

2022-01-11T11:50:38.000+0000
UpdateTimestring

The time of the last modification.

2022-01-12T05:24:31.000+0000
Namespacesarray<object>

The queried namespaces.

object

The data structure.

Namestring

The name of the namespace in the ACK cluster.

default
MseNamespacestring

The name of the MSE namespace that you want to access.

default
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
True

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "5B170A0D-2C5D-4CF8-B808-03966B86****",
  "Data": {
    "ClusterId": "cd23228b3c80c4d4f9ad7af1d87cc30d5",
    "ClusterName": "myCluster",
    "Region": "cn-hangzhou",
    "K8sVersion": "1.20.11-aliyun.1",
    "NamespaceInfos": "[{\\\"Name\\\":\\\"ack-onepilot\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"default\\\",\\\"Tags\\\":{\\\"mse-enable\\\":\\\"enabled\\\"}},{\\\"Name\\\":\\\"kube-node-lease\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"kube-public\\\",\\\"Tags\\\":null},{\\\"Name\\\":\\\"kube-system\\\",\\\"Tags\\\":null}]",
    "PilotStartTime": "2022-01-11T11:50:38.000+0000",
    "UpdateTime": "2022-01-12T05:24:31.000+0000",
    "Namespaces": [
      {
        "Name": "default",
        "MseNamespace": "default"
      }
    ]
  },
  "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-09-05The response structure of the API has changedView Change Details
2023-08-11API Description Update. The response structure of the API has changedView Change Details
2023-06-26The response structure of the API has changedView Change Details