DATASOURCE::EDAS::Clusters is used to query clusters.

Syntax

{
  "Type": "DATASOURCE::EDAS::Clusters",
  "Properties": {
    "LogicalRegionId": String,
    "ResourceGroupId": String
  }
}

Properties

Property Type Required Editable Description Constraint
LogicalRegionId String No Yes The ID of the namespace. The following rules apply:
  • If you leave this property empty, the clusters in the default namespace are queried.
  • If you specify this property, the clusters in the specified namespace are queried.
ResourceGroupId String No Yes The ID of the resource group. The following rules apply:
  • If you leave this property empty, the clusters in the default resource group are queried.
  • If you specify this property, the clusters in the specified resource group are queried.

Return values (Fn::GetAtt)

  • ClusterIds: the cluster IDs.
  • ClusterIds: details of the clusters.
Property Type Description Constraint
ClusterIds List The cluster IDs. None.
Clusters List Details of the clusters. None.
ClusterId String The ID of the cluster. None.
ClusterName String The name of the cluster. None.
OversoldFactor Number The CPU overcommit ratio that is supported by a Docker cluster. None.
NodeNum Number The number of instances. None.
ResourceGroupId String The ID of the resource group. None.
ClusterType Number The type of the cluster. Valid values:
  • 0: regular Docker cluster
  • 1: Swarm cluster
  • 2: Elastic Compute Service (ECS) cluster
  • 3: self-managed Kubernetes cluster in EDAS
  • 4: cluster in which Pandora automatically registers applications
  • 5: Container Service for Kubernetes (ACK) cluster
CsClusterId String The ID of the ACK cluster. None.
VpcId String The ID of the virtual private cloud (VPC). None.
RegionId String The ID of the region. None.
IaasProvider String The provider of the cluster. None.
Cpu String The total number of CPUs. None.
CpuUsed Number The number of used CPUs. None.
Mem Number The total size of memory. Unit: MB.
MemUsed Number The size of the used memory. Unit: MB.
CreateTime Number The time when the cluster was created.

Unit: milliseconds.

UpdateTime Number The time when the cluster was last updated.

Unit: milliseconds.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "LogicalRegionId": {
      "Type": "String",
      "Description": "The ID of the namespace."
    }
  },
  "Resources": {
    "Clusters": {
      "Type": "DATASOURCE::EDAS::Clusters",
      "Properties": {
        "LogicalRegionId": {
          "Ref": "LogicalRegionId"
        }
      }
    }
  },
  "Outputs": {
    "Clusters": {
      "Description": "The list of clusters.",
      "Value": {
        "Fn::GetAtt": [
          "Clusters",
          "Clusters"
        ]
      }
    },
    "ClusterIds": {
      "Description": "The list of cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "Clusters",
          "ClusterIds"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  LogicalRegionId:
    Type: String
    Description: The ID of the namespace.
Resources:
  Clusters:
    Type: DATASOURCE::EDAS::Clusters
    Properties:
      LogicalRegionId:
        Ref: LogicalRegionId
Outputs:
  Clusters:
    Description: The list of clusters.
    Value:
      Fn::GetAtt:
        - Clusters
        - Clusters
  ClusterIds:
    Description: The list of cluster IDs.
    Value:
      Fn::GetAtt:
        - Clusters
        - ClusterIds