All Products
Search
Document Center

Security Center:ListPrivateK8s

Last Updated:Dec 13, 2024

Queries the information about the self-managed Kubernetes clusters that are added to Security Center.

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
yundun-sas:ListPrivateK8slist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

52870893-48A7-5A9E-9E05-6253E5B6****
PrivateK8sInfosarray<object>

The information about the self-managed Kubernetes clusters.

PrivateK8sInfoobject
VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-2zet5l358k6z0gnz*****
ApiServerIpstring

The IP address of the API server.

192.168.XX.XX
K8sVersionstring

The version of Kubernetes.

1.18
NetTypelong

The network type. Valid values:

  • 1: Internet.
  • 2: VPC.
1
ClusterNamestring

The name of the cluster.

xxx
KubeConfigstring

The server configuration of Kubernetes.

xxx
AliUidlong

The ID of the Alibaba Cloud account.

12345
Idlong

The ID of the policy.

1
RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "52870893-48A7-5A9E-9E05-6253E5B6****",
  "PrivateK8sInfos": [
    {
      "VpcId": "vpc-2zet5l358k6z0gnz*****",
      "ApiServerIp": "192.168.XX.XX",
      "K8sVersion": "1.18",
      "NetType": 1,
      "ClusterName": "xxx",
      "KubeConfig": "xxx",
      "AliUid": 12345,
      "Id": 1,
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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