DATASOURCE::MSE::Clusters is used to query the clusters of Microservices Registry.

Syntax

{
  "Type": "DATASOURCE::MSE::Clusters",
  "Properties": {
    "ClusterAliasName": String
  }
}

Properties

Property Type Required Editable Description Constraint
ClusterAliasName String No Yes The name of the cluster. Fuzzy match is supported.

Return values (Fn::GetAtt)

  • ClusterIds: the IDs of the clusters.
  • Clusters: the details of the clusters.
Parameter Type Description Constraint
ClusterIds List The IDs of the clusters. None.
Clusters List The details of the clusters. None.
ClusterId String The ID of the cluster. None.
ClusterName String The name of the cluster. None.
ClusterAliasName String The alias of the cluster. None.
InstanceId String The ID of the instance. None.
AppVersion String The version of the application. None.
VersionCode String The version of the cluster. None.
InstanceCount Number The number of clusters. None.
IntranetAddress String The private IP address of the cluster. None.
CanUpdate Boolean Indicates whether the cluster can be updated. Valid values:
  • true: The cluster can be updated.
  • false: The cluster cannot be updated.
ChargeType String The billing method of the cluster. Valid values:
  • PrePaid: subscription
  • PostPaid: pay-as-you-go
InitStatus String The initialization state of the cluster. None.
InternetAddress String The public IP address of the cluster. None.
IntranetDomain String The private domain name. None.
CreateTime String The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
EndDate String The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterAliasName": {
      "Type": "String",
      "Description": "The alias name of cluster."
    }
  },
  "Resources": {
    "Clusters": {
      "Type": "DATASOURCE::MSE::Clusters",
      "Properties": {
        "ClusterAliasName": {
          "Ref": "ClusterAliasName"
        }
      }
    }
  },
  "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:
  ClusterAliasName:
    Type: String
    Description: The alias name of cluster.
Resources:
  Clusters:
    Type: DATASOURCE::MSE::Clusters
    Properties:
      ClusterAliasName:
        Ref: ClusterAliasName
Outputs:
  Clusters:
    Description: The list of clusters.
    Value:
      Fn::GetAtt:
        - Clusters
        - Clusters
  ClusterIds:
    Description: The list of cluster IDs.
    Value:
      Fn::GetAtt:
        - Clusters
        - ClusterIds