volcenginecc.vke.getCluster

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

> Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:vke/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getCluster Result

The following output properties are available:

ClusterConfig Volcengine.GetClusterClusterConfig: Network configuration for the cluster control plane and some nodes.
ClusterId string: Cluster ID.
CreatedTime string: Cluster creation time. Standard RFC3339 format, UTC+0.
DeleteProtectionEnabled bool: Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
Description string: Cluster description. Maximum length is 300 characters.
Id string: Uniquely identifies the resource.
IrsaConfig Volcengine.GetClusterIrsaConfig: IRSA (IAM Role for Service Account) capability parameter configuration
KubernetesVersion string: Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
KubernetesVersionCreate string: Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
LoggingConfig Volcengine.GetClusterLoggingConfig: Cluster log configuration information.
Message string: Cluster status description.
MonitoringConfig Volcengine.GetClusterMonitoringConfig: Monitoring configuration information.
Name string: Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
NodeStatistics Volcengine.GetClusterNodeStatistics: Statistics of node counts for each main status in the cluster.
PodsConfig Volcengine.GetClusterPodsConfig: Pod network configuration.
ProjectName string: Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
ServicesConfig Volcengine.GetClusterServicesConfig: Network configuration for the service.
SourceRegion string: Cluster source region
Status Volcengine.GetClusterStatus: Cluster status.
Tags List<Volcengine.GetClusterTag>: Cluster tags.
Type string: Cluster type.
UpdatedTime string: Last update time of the cluster. Standard RFC3339 format, UTC+0.

ClusterConfig GetClusterClusterConfig: Network configuration for the cluster control plane and some nodes.
ClusterId string: Cluster ID.
CreatedTime string: Cluster creation time. Standard RFC3339 format, UTC+0.
DeleteProtectionEnabled bool: Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
Description string: Cluster description. Maximum length is 300 characters.
Id string: Uniquely identifies the resource.
IrsaConfig GetClusterIrsaConfig: IRSA (IAM Role for Service Account) capability parameter configuration
KubernetesVersion string: Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
KubernetesVersionCreate string: Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
LoggingConfig GetClusterLoggingConfig: Cluster log configuration information.
Message string: Cluster status description.
MonitoringConfig GetClusterMonitoringConfig: Monitoring configuration information.
Name string: Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
NodeStatistics GetClusterNodeStatistics: Statistics of node counts for each main status in the cluster.
PodsConfig GetClusterPodsConfig: Pod network configuration.
ProjectName string: Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
ServicesConfig GetClusterServicesConfig: Network configuration for the service.
SourceRegion string: Cluster source region
Status GetClusterStatus: Cluster status.
Tags []GetClusterTag: Cluster tags.
Type string: Cluster type.
UpdatedTime string: Last update time of the cluster. Standard RFC3339 format, UTC+0.

clusterConfig GetClusterClusterConfig: Network configuration for the cluster control plane and some nodes.
clusterId String: Cluster ID.
createdTime String: Cluster creation time. Standard RFC3339 format, UTC+0.
deleteProtectionEnabled Boolean: Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
description String: Cluster description. Maximum length is 300 characters.
id String: Uniquely identifies the resource.
irsaConfig GetClusterIrsaConfig: IRSA (IAM Role for Service Account) capability parameter configuration
kubernetesVersion String: Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
kubernetesVersionCreate String: Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
loggingConfig GetClusterLoggingConfig: Cluster log configuration information.
message String: Cluster status description.
monitoringConfig GetClusterMonitoringConfig: Monitoring configuration information.
name String: Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
nodeStatistics GetClusterNodeStatistics: Statistics of node counts for each main status in the cluster.
podsConfig GetClusterPodsConfig: Pod network configuration.
projectName String: Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
servicesConfig GetClusterServicesConfig: Network configuration for the service.
sourceRegion String: Cluster source region
status GetClusterStatus: Cluster status.
tags List<GetClusterTag>: Cluster tags.
type String: Cluster type.
updatedTime String: Last update time of the cluster. Standard RFC3339 format, UTC+0.

clusterConfig GetClusterClusterConfig: Network configuration for the cluster control plane and some nodes.
clusterId string: Cluster ID.
createdTime string: Cluster creation time. Standard RFC3339 format, UTC+0.
deleteProtectionEnabled boolean: Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
description string: Cluster description. Maximum length is 300 characters.
id string: Uniquely identifies the resource.
irsaConfig GetClusterIrsaConfig: IRSA (IAM Role for Service Account) capability parameter configuration
kubernetesVersion string: Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
kubernetesVersionCreate string: Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
loggingConfig GetClusterLoggingConfig: Cluster log configuration information.
message string: Cluster status description.
monitoringConfig GetClusterMonitoringConfig: Monitoring configuration information.
name string: Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
nodeStatistics GetClusterNodeStatistics: Statistics of node counts for each main status in the cluster.
podsConfig GetClusterPodsConfig: Pod network configuration.
projectName string: Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
servicesConfig GetClusterServicesConfig: Network configuration for the service.
sourceRegion string: Cluster source region
status GetClusterStatus: Cluster status.
tags GetClusterTag[]: Cluster tags.
type string: Cluster type.
updatedTime string: Last update time of the cluster. Standard RFC3339 format, UTC+0.

cluster_config GetClusterClusterConfig: Network configuration for the cluster control plane and some nodes.
cluster_id str: Cluster ID.
created_time str: Cluster creation time. Standard RFC3339 format, UTC+0.
delete_protection_enabled bool: Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
description str: Cluster description. Maximum length is 300 characters.
id str: Uniquely identifies the resource.
irsa_config GetClusterIrsaConfig: IRSA (IAM Role for Service Account) capability parameter configuration
kubernetes_version str: Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
kubernetes_version_create str: Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
logging_config GetClusterLoggingConfig: Cluster log configuration information.
message str: Cluster status description.
monitoring_config GetClusterMonitoringConfig: Monitoring configuration information.
name str: Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
node_statistics GetClusterNodeStatistics: Statistics of node counts for each main status in the cluster.
pods_config GetClusterPodsConfig: Pod network configuration.
project_name str: Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
services_config GetClusterServicesConfig: Network configuration for the service.
source_region str: Cluster source region
status GetClusterStatus: Cluster status.
tags Sequence[GetClusterTag]: Cluster tags.
type str: Cluster type.
updated_time str: Last update time of the cluster. Standard RFC3339 format, UTC+0.

clusterConfig Property Map: Network configuration for the cluster control plane and some nodes.
clusterId String: Cluster ID.
createdTime String: Cluster creation time. Standard RFC3339 format, UTC+0.
deleteProtectionEnabled Boolean: Cluster deletion protection. Values: false (default): Deletion protection is disabled. true: Deletion protection is enabled; the cluster cannot be deleted directly.
description String: Cluster description. Maximum length is 300 characters.
id String: Uniquely identifies the resource.
irsaConfig Property Map: IRSA (IAM Role for Service Account) capability parameter configuration
kubernetesVersion String: Cluster Kubernetes version in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version (for query use)
kubernetesVersionCreate String: Kubernetes version of the cluster, in the format x.xx. When creating a cluster, the system automatically matches the latest VKE version corresponding to this Kubernetes version. (For creation)
loggingConfig Property Map: Cluster log configuration information.
message String: Cluster status description.
monitoringConfig Property Map: Monitoring configuration information.
name String: Cluster name. Must be unique within the same region. Supports uppercase and lowercase English letters, Chinese characters, numbers, and hyphens (-). Length must be 2–64 characters.
nodeStatistics Property Map: Statistics of node counts for each main status in the cluster.
podsConfig Property Map: Pod network configuration.
projectName String: Project name to which the cluster belongs. A cluster can belong to only one project. Only English letters, numbers, underscores (_), periods (.), and hyphens (-) are allowed. Maximum length: 64 characters. Default: default.
servicesConfig Property Map: Network configuration for the service.
sourceRegion String: Cluster source region
status Property Map: Cluster status.
tags List<Property Map>: Cluster tags.
type String: Cluster type.
updatedTime String: Last update time of the cluster. Standard RFC3339 format, UTC+0.

Supporting Types

GetClusterClusterConfig

ApiServerEndpoints Volcengine.GetClusterClusterConfigApiServerEndpoints: Cluster API Server access IPv4 address information
ApiServerPublicAccessConfig Volcengine.GetClusterClusterConfigApiServerPublicAccessConfig: Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
ApiServerPublicAccessEnabled bool: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
IpFamily string: Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
ResourcePublicAccessDefaultEnabled bool: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
SecurityGroupIds List<string>: Security group used by the cluster control plane and nodes.
SubnetIds List<string>: Subnet ID for cluster control plane communication within the private network.
VpcId string: Private network (VPC) ID where the cluster control plane and some nodes are located.

ApiServerEndpoints GetClusterClusterConfigApiServerEndpoints: Cluster API Server access IPv4 address information
ApiServerPublicAccessConfig GetClusterClusterConfigApiServerPublicAccessConfig: Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
ApiServerPublicAccessEnabled bool: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
IpFamily string: Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
ResourcePublicAccessDefaultEnabled bool: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
SecurityGroupIds []string: Security group used by the cluster control plane and nodes.
SubnetIds []string: Subnet ID for cluster control plane communication within the private network.
VpcId string: Private network (VPC) ID where the cluster control plane and some nodes are located.

apiServerEndpoints GetClusterClusterConfigApiServerEndpoints: Cluster API Server access IPv4 address information
apiServerPublicAccessConfig GetClusterClusterConfigApiServerPublicAccessConfig: Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
apiServerPublicAccessEnabled Boolean: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
ipFamily String: Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
resourcePublicAccessDefaultEnabled Boolean: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
securityGroupIds List<String>: Security group used by the cluster control plane and nodes.
subnetIds List<String>: Subnet ID for cluster control plane communication within the private network.
vpcId String: Private network (VPC) ID where the cluster control plane and some nodes are located.

apiServerEndpoints GetClusterClusterConfigApiServerEndpoints: Cluster API Server access IPv4 address information
apiServerPublicAccessConfig GetClusterClusterConfigApiServerPublicAccessConfig: Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
apiServerPublicAccessEnabled boolean: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
ipFamily string: Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
resourcePublicAccessDefaultEnabled boolean: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
securityGroupIds string[]: Security group used by the cluster control plane and nodes.
subnetIds string[]: Subnet ID for cluster control plane communication within the private network.
vpcId string: Private network (VPC) ID where the cluster control plane and some nodes are located.

api_server_endpoints GetClusterClusterConfigApiServerEndpoints: Cluster API Server access IPv4 address information
api_server_public_access_config GetClusterClusterConfigApiServerPublicAccessConfig: Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
api_server_public_access_enabled bool: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
ip_family str: Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
resource_public_access_default_enabled bool: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
security_group_ids Sequence[str]: Security group used by the cluster control plane and nodes.
subnet_ids Sequence[str]: Subnet ID for cluster control plane communication within the private network.
vpc_id str: Private network (VPC) ID where the cluster control plane and some nodes are located.

apiServerEndpoints Property Map: Cluster API Server access IPv4 address information
apiServerPublicAccessConfig Property Map: Cluster API Server public access configuration. This parameter is returned only when ApiServerPublicAccessEnable=true
apiServerPublicAccessEnabled Boolean: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
ipFamily String: Cluster network protocol stack. Parameter value description: Ipv4: Ipv4 single stack. Ipv6: [Invitation test · Trial application] Ipv6 single stack. DualStack: [Invitation test · Trial application] Ipv4 and Ipv6 dual stack
resourcePublicAccessDefaultEnabled Boolean: Node public access configuration. Parameter value description: false: Disabled. true: Enabled
securityGroupIds List<String>: Security group used by the cluster control plane and nodes.
subnetIds List<String>: Subnet ID for cluster control plane communication within the private network.
vpcId String: Private network (VPC) ID where the cluster control plane and some nodes are located.

GetClusterClusterConfigApiServerEndpoints

PrivateIp Volcengine.GetClusterClusterConfigApiServerEndpointsPrivateIp: Cluster API Server private IPv4 address.
PublicIp Volcengine.GetClusterClusterConfigApiServerEndpointsPublicIp: Cluster API Server public IPv4 address

PrivateIp GetClusterClusterConfigApiServerEndpointsPrivateIp: Cluster API Server private IPv4 address.
PublicIp GetClusterClusterConfigApiServerEndpointsPublicIp: Cluster API Server public IPv4 address

privateIp GetClusterClusterConfigApiServerEndpointsPrivateIp: Cluster API Server private IPv4 address.
publicIp GetClusterClusterConfigApiServerEndpointsPublicIp: Cluster API Server public IPv4 address

privateIp GetClusterClusterConfigApiServerEndpointsPrivateIp: Cluster API Server private IPv4 address.
publicIp GetClusterClusterConfigApiServerEndpointsPublicIp: Cluster API Server public IPv4 address

private_ip GetClusterClusterConfigApiServerEndpointsPrivateIp: Cluster API Server private IPv4 address.
public_ip GetClusterClusterConfigApiServerEndpointsPublicIp: Cluster API Server public IPv4 address

privateIp Property Map: Cluster API Server private IPv4 address.
publicIp Property Map: Cluster API Server public IPv4 address

GetClusterClusterConfigApiServerEndpointsPrivateIp

Ipv4 string: IPv4 address of the private network IP.

Ipv4 string: IPv4 address of the private network IP.

ipv4 String: IPv4 address of the private network IP.

ipv4 string: IPv4 address of the private network IP.

ipv4 str: IPv4 address of the private network IP.

ipv4 String: IPv4 address of the private network IP.

GetClusterClusterConfigApiServerEndpointsPublicIp

Ipv4 string: IPv4 address of the public IP.

Ipv4 string: IPv4 address of the public IP.

ipv4 String: IPv4 address of the public IP.

ipv4 string: IPv4 address of the public IP.

ipv4 str: IPv4 address of the public IP.

ipv4 String: IPv4 address of the public IP.

GetClusterClusterConfigApiServerPublicAccessConfig

PublicAccessNetworkConfig Volcengine.GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig: Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true

PublicAccessNetworkConfig GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig: Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true

publicAccessNetworkConfig GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig: Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true

publicAccessNetworkConfig GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig: Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true

public_access_network_config GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig: Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true

publicAccessNetworkConfig Property Map: Public access network configuration. This parameter is returned only when ApiServerPublicAccessEnable=true

GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig

Bandwidth int: Peak bandwidth of the public IP, unit: Mbps
BillingType int: Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
Isp string: Line type of the public IP. Parameter value description: BGP: BGP (multi-line)

Bandwidth int: Peak bandwidth of the public IP, unit: Mbps
BillingType int: Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
Isp string: Line type of the public IP. Parameter value description: BGP: BGP (multi-line)

bandwidth Integer: Peak bandwidth of the public IP, unit: Mbps
billingType Integer: Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
isp String: Line type of the public IP. Parameter value description: BGP: BGP (multi-line)

bandwidth number: Peak bandwidth of the public IP, unit: Mbps
billingType number: Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
isp string: Line type of the public IP. Parameter value description: BGP: BGP (multi-line)

bandwidth int: Peak bandwidth of the public IP, unit: Mbps
billing_type int: Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
isp str: Line type of the public IP. Parameter value description: BGP: BGP (multi-line)

bandwidth Number: Peak bandwidth of the public IP, unit: Mbps
billingType Number: Billing type for public IP: 2: Pay-as-you-go by bandwidth cap. 3: Pay-as-you-go by actual traffic.
isp String: Line type of the public IP. Parameter value description: BGP: BGP (multi-line)

GetClusterIrsaConfig

Audience string: Identifier for accepting tokens
Enabled bool: Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
Issuer string: OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
JwksUrl string: JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
OidcTrn string: OIDC provider TRN.
OpenIdConfigUrl string: OIDC provider configuration document in JSON format, containing information about the OIDC provider.

Audience string: Identifier for accepting tokens
Enabled bool: Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
Issuer string: OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
JwksUrl string: JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
OidcTrn string: OIDC provider TRN.
OpenIdConfigUrl string: OIDC provider configuration document in JSON format, containing information about the OIDC provider.

audience String: Identifier for accepting tokens
enabled Boolean: Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
issuer String: OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
jwksUrl String: JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
oidcTrn String: OIDC provider TRN.
openIdConfigUrl String: OIDC provider configuration document in JSON format, containing information about the OIDC provider.

audience string: Identifier for accepting tokens
enabled boolean: Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
issuer string: OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
jwksUrl string: JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
oidcTrn string: OIDC provider TRN.
openIdConfigUrl string: OIDC provider configuration document in JSON format, containing information about the OIDC provider.

audience str: Identifier for accepting tokens
enabled bool: Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
issuer str: OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
jwks_url str: JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
oidc_trn str: OIDC provider TRN.
open_id_config_url str: OIDC provider configuration document in JSON format, containing information about the OIDC provider.

audience String: Identifier for accepting tokens
enabled Boolean: Whether to enable IRSA feature. Parameter values: true: enabled; false: not enabled.
issuer String: OIDC (OpenID Connect) provider URL, the unique identifier for the OIDC provider.
jwksUrl String: JWKS (JSON Web Key Set) URL. The public keys in the file are used to verify any JWT (JSON Web Tokens) returned from the OIDC provider.
oidcTrn String: OIDC provider TRN.
openIdConfigUrl String: OIDC provider configuration document in JSON format, containing information about the OIDC provider.

GetClusterLoggingConfig

LogProjectId string: Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
LogSetups List<Volcengine.GetClusterLoggingConfigLogSetup>: Cluster log option information.

LogProjectId string: Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
LogSetups []GetClusterLoggingConfigLogSetup: Cluster log option information.

logProjectId String: Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
logSetups List<GetClusterLoggingConfigLogSetup>: Cluster log option information.

logProjectId string: Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
logSetups GetClusterLoggingConfigLogSetup[]: Cluster log option information.

log_project_id str: Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
log_setups Sequence[GetClusterLoggingConfigLogSetup]: Cluster log option information.

logProjectId String: Cluster log project (Log Project) ID. If empty, the cluster log project has not been created.
logSetups List<Property Map>: Cluster log option information.

GetClusterLoggingConfigLogSetup

Enabled bool: Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
LogTopicId string: TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.
LogTtl int: Retention period of logs in log service, in days. 3650 days means permanent storage.
LogType string: Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.

Enabled bool: Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
LogTopicId string: TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.
LogTtl int: Retention period of logs in log service, in days. 3650 days means permanent storage.
LogType string: Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.

enabled Boolean: Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
logTopicId String: TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.
logTtl Integer: Retention period of logs in log service, in days. 3650 days means permanent storage.
logType String: Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.

enabled boolean: Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
logTopicId string: TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.
logTtl number: Retention period of logs in log service, in days. 3650 days means permanent storage.
logType string: Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.

enabled bool: Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
log_topic_id str: TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.
log_ttl int: Retention period of logs in log service, in days. 3650 days means permanent storage.
log_type str: Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.

enabled Boolean: Whether to enable this log option. Parameter values: true: enabled; false: not enabled.
logTopicId String: TLS log topic ID for the collection target. If empty, the corresponding log topic has not been created.
logTtl Number: Retention period of logs in log service, in days. 3650 days means permanent storage.
logType String: Currently enabled log types. Parameter values: Audit: cluster audit log; KubeApiServer: kube-apiserver component log; KubeScheduler: kube-scheduler component log; KubeControllerManager: kube-controller-manager component log.

GetClusterMonitoringConfig

ComponentConfigs List<Volcengine.GetClusterMonitoringConfigComponentConfig>: List of monitoring component configurations.
EnableMetricsExternalCollection bool: Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
WorkspaceId string: Workspace ID to which the monitoring data belongs.

ComponentConfigs []GetClusterMonitoringConfigComponentConfig: List of monitoring component configurations.
EnableMetricsExternalCollection bool: Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
WorkspaceId string: Workspace ID to which the monitoring data belongs.

componentConfigs List<GetClusterMonitoringConfigComponentConfig>: List of monitoring component configurations.
enableMetricsExternalCollection Boolean: Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
workspaceId String: Workspace ID to which the monitoring data belongs.

componentConfigs GetClusterMonitoringConfigComponentConfig[]: List of monitoring component configurations.
enableMetricsExternalCollection boolean: Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
workspaceId string: Workspace ID to which the monitoring data belongs.

component_configs Sequence[GetClusterMonitoringConfigComponentConfig]: List of monitoring component configurations.
enable_metrics_external_collection bool: Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
workspace_id str: Workspace ID to which the monitoring data belongs.

componentConfigs List<Property Map>: List of monitoring component configurations.
enableMetricsExternalCollection Boolean: Whether to enable external Prometheus to collect control plane component metrics for the cluster. Parameter values: true: enabled. false: not enabled.
workspaceId String: Workspace ID to which the monitoring data belongs.

GetClusterMonitoringConfigComponentConfig

Enabled bool: Whether to enable this monitoring component. true means enabled; false means disabled.
Name string: Name of the monitoring component, such as 'prometheus', 'grafana', etc.

Enabled bool: Whether to enable this monitoring component. true means enabled; false means disabled.
Name string: Name of the monitoring component, such as 'prometheus', 'grafana', etc.

enabled Boolean: Whether to enable this monitoring component. true means enabled; false means disabled.
name String: Name of the monitoring component, such as 'prometheus', 'grafana', etc.

enabled boolean: Whether to enable this monitoring component. true means enabled; false means disabled.
name string: Name of the monitoring component, such as 'prometheus', 'grafana', etc.

enabled bool: Whether to enable this monitoring component. true means enabled; false means disabled.
name str: Name of the monitoring component, such as 'prometheus', 'grafana', etc.

enabled Boolean: Whether to enable this monitoring component. true means enabled; false means disabled.
name String: Name of the monitoring component, such as 'prometheus', 'grafana', etc.

GetClusterNodeStatistics

CreatingCount int: Total number of nodes in Phase=Creating.
DeletingCount int: Total number of nodes with Phase=Deleting.
FailedCount int: Total number of nodes with Phase=Failed.
RunningCount int: Total number of nodes with Phase=Running.
TotalCount int: Total number of nodes.
UpdatingCount int: Total number of nodes in Phase=Updating.

CreatingCount int: Total number of nodes in Phase=Creating.
DeletingCount int: Total number of nodes with Phase=Deleting.
FailedCount int: Total number of nodes with Phase=Failed.
RunningCount int: Total number of nodes with Phase=Running.
TotalCount int: Total number of nodes.
UpdatingCount int: Total number of nodes in Phase=Updating.

creatingCount Integer: Total number of nodes in Phase=Creating.
deletingCount Integer: Total number of nodes with Phase=Deleting.
failedCount Integer: Total number of nodes with Phase=Failed.
runningCount Integer: Total number of nodes with Phase=Running.
totalCount Integer: Total number of nodes.
updatingCount Integer: Total number of nodes in Phase=Updating.

creatingCount number: Total number of nodes in Phase=Creating.
deletingCount number: Total number of nodes with Phase=Deleting.
failedCount number: Total number of nodes with Phase=Failed.
runningCount number: Total number of nodes with Phase=Running.
totalCount number: Total number of nodes.
updatingCount number: Total number of nodes in Phase=Updating.

creating_count int: Total number of nodes in Phase=Creating.
deleting_count int: Total number of nodes with Phase=Deleting.
failed_count int: Total number of nodes with Phase=Failed.
running_count int: Total number of nodes with Phase=Running.
total_count int: Total number of nodes.
updating_count int: Total number of nodes in Phase=Updating.

creatingCount Number: Total number of nodes in Phase=Creating.
deletingCount Number: Total number of nodes with Phase=Deleting.
failedCount Number: Total number of nodes with Phase=Failed.
runningCount Number: Total number of nodes with Phase=Running.
totalCount Number: Total number of nodes.
updatingCount Number: Total number of nodes in Phase=Updating.

GetClusterPodsConfig

FlannelConfig Volcengine.GetClusterPodsConfigFlannelConfig: Flannel network configuration.
PodNetworkMode string: Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
VpcCniConfig Volcengine.GetClusterPodsConfigVpcCniConfig: VPC-CNI network configuration.

FlannelConfig GetClusterPodsConfigFlannelConfig: Flannel network configuration.
PodNetworkMode string: Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
VpcCniConfig GetClusterPodsConfigVpcCniConfig: VPC-CNI network configuration.

flannelConfig GetClusterPodsConfigFlannelConfig: Flannel network configuration.
podNetworkMode String: Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
vpcCniConfig GetClusterPodsConfigVpcCniConfig: VPC-CNI network configuration.

flannelConfig GetClusterPodsConfigFlannelConfig: Flannel network configuration.
podNetworkMode string: Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
vpcCniConfig GetClusterPodsConfigVpcCniConfig: VPC-CNI network configuration.

flannel_config GetClusterPodsConfigFlannelConfig: Flannel network configuration.
pod_network_mode str: Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
vpc_cni_config GetClusterPodsConfigVpcCniConfig: VPC-CNI network configuration.

flannelConfig Property Map: Flannel network configuration.
podNetworkMode String: Container (Pod) network model (CNI). Parameter values: Flannel: Flannel network model, an independent underlay container network model. VpcCniShared: VPC-CNI network model, an underlay container network model implemented with ENI (Elastic Network Interface) on a private network.
vpcCniConfig Property Map: VPC-CNI network configuration.

GetClusterPodsConfigFlannelConfig

MaxPodsPerNode int: Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
PodCidrs List<string>: Pod CIDR for Flannel container network.
SubnetIds List<string>: List of Pod subnet IDs for the Flannel container network model.

MaxPodsPerNode int: Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
PodCidrs []string: Pod CIDR for Flannel container network.
SubnetIds []string: List of Pod subnet IDs for the Flannel container network model.

maxPodsPerNode Integer: Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
podCidrs List<String>: Pod CIDR for Flannel container network.
subnetIds List<String>: List of Pod subnet IDs for the Flannel container network model.

maxPodsPerNode number: Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
podCidrs string[]: Pod CIDR for Flannel container network.
subnetIds string[]: List of Pod subnet IDs for the Flannel container network model.

max_pods_per_node int: Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
pod_cidrs Sequence[str]: Pod CIDR for Flannel container network.
subnet_ids Sequence[str]: List of Pod subnet IDs for the Flannel container network model.

maxPodsPerNode Number: Maximum number of Pod instances per node for the Flannel container network model. Values: 64 (default), 16, 32, 128, 256.
podCidrs List<String>: Pod CIDR for Flannel container network.
subnetIds List<String>: List of Pod subnet IDs for the Flannel container network model.

GetClusterPodsConfigVpcCniConfig

SubnetIds List<string>: List of Pod subnet IDs for the VPC-CNI container network model.
TrunkEniEnabled bool: Whether to enable Trunk mode for the VPC-CNI container network model

SubnetIds []string: List of Pod subnet IDs for the VPC-CNI container network model.
TrunkEniEnabled bool: Whether to enable Trunk mode for the VPC-CNI container network model

subnetIds List<String>: List of Pod subnet IDs for the VPC-CNI container network model.
trunkEniEnabled Boolean: Whether to enable Trunk mode for the VPC-CNI container network model

subnetIds string[]: List of Pod subnet IDs for the VPC-CNI container network model.
trunkEniEnabled boolean: Whether to enable Trunk mode for the VPC-CNI container network model

subnet_ids Sequence[str]: List of Pod subnet IDs for the VPC-CNI container network model.
trunk_eni_enabled bool: Whether to enable Trunk mode for the VPC-CNI container network model

subnetIds List<String>: List of Pod subnet IDs for the VPC-CNI container network model.
trunkEniEnabled Boolean: Whether to enable Trunk mode for the VPC-CNI container network model

GetClusterServicesConfig

ServiceCidrsv4s List<string>: IPv4 private network address exposed by Kubernetes Service.

ServiceCidrsv4s []string: IPv4 private network address exposed by Kubernetes Service.

serviceCidrsv4s List<String>: IPv4 private network address exposed by Kubernetes Service.

serviceCidrsv4s string[]: IPv4 private network address exposed by Kubernetes Service.

service_cidrsv4s Sequence[str]: IPv4 private network address exposed by Kubernetes Service.

serviceCidrsv4s List<String>: IPv4 private network address exposed by Kubernetes Service.

GetClusterStatus

Conditions List<Volcengine.GetClusterStatusCondition>: Status condition list
Phase string: Cluster status phase.

Conditions []GetClusterStatusCondition: Status condition list
Phase string: Cluster status phase.

conditions List<GetClusterStatusCondition>: Status condition list
phase String: Cluster status phase.

conditions GetClusterStatusCondition[]: Status condition list
phase string: Cluster status phase.

conditions Sequence[GetClusterStatusCondition]: Status condition list
phase str: Cluster status phase.

conditions List<Property Map>: Status condition list
phase String: Cluster status phase.

GetClusterStatusCondition

Type string: Condition type

Type string: Condition type

type String: Condition type

type string: Condition type

type str: Condition type

type String: Condition type

GetClusterTag

Key string: Tag key.
Value string: Tag value.

Key string: Tag key.
Value string: Tag value.

key String: Tag key.
value String: Tag value.

key string: Tag key.
value string: Tag value.

key str: Tag key.
value str: Tag value.

key String: Tag key.
value String: Tag value.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.vke.getCluster

On this page

On this page

Using getCluster

getCluster Result

Supporting Types

GetClusterClusterConfig

GetClusterClusterConfigApiServerEndpoints

GetClusterClusterConfigApiServerEndpointsPrivateIp

GetClusterClusterConfigApiServerEndpointsPublicIp

GetClusterClusterConfigApiServerPublicAccessConfig

GetClusterClusterConfigApiServerPublicAccessConfigPublicAccessNetworkConfig

GetClusterIrsaConfig

GetClusterLoggingConfig

GetClusterLoggingConfigLogSetup

GetClusterMonitoringConfig

GetClusterMonitoringConfigComponentConfig

GetClusterNodeStatistics

GetClusterPodsConfig

GetClusterPodsConfigFlannelConfig

GetClusterPodsConfigVpcCniConfig

GetClusterServicesConfig

GetClusterStatus

GetClusterStatusCondition

GetClusterTag

Package Details

On this page

On this page