All Products
Search
Document Center

Microservices Engine:GetKubernetesSource

Last Updated:Nov 20, 2024

Obtains sources of all Container Service for Kubernetes (ACK) services in a gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:GetKubernetesSourceget
*Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-c5d1aadb7df646cfb7065fbf75c1****
VpcIdstringNo

The ID of the virtual private cloud (VPC).

vpc-bp1t50e045b5g7i3p****
IsAllbooleanNo

Specifies whether to obtain the information about all Kubernetes clusters. If you set the value to false, only the information about unassociated clusters is obtained.

AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

You are not authorized to perform this operation.
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Dataarray<object>

The data returned.

K8sSourcesobject

The response parameters.

Namestring

The name of the ACK cluster.

k8s-demo
Clusterstring

The ID of the ACK cluster.

cbc1efca895a64af097ff00b26f3f****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1085A66C-DEF1-58EE-A0A4-31E00C9FC0D5",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Name": "k8s-demo",
      "Cluster": "cbc1efca895a64af097ff00b26f3f****"
    }
  ]
}

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 request parameters of the API has changedView Change Details