Query the information about Lindorm instances - Resource Orchestration Service

DATASOURCE::Lindorm::Instances is used to query the information about Lindorm instances.

Syntax

{
  "Type": "DATASOURCE::Lindorm::Instances",
  "Properties": {
    "ResourceGroupId": String,
    "ServiceType": String,
    "QueryStr": String,
    "InstanceIds": List,
    "SupportEngine": Integer,
    "Tags": List,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
ServiceType	String	No	Yes	The category of the instance.	Valid values: lindorm: single-zone Lindorm instance lindorm_multizone: multi-zone Lindorm instance serverless_lindorm: Lindorm Serverless instance lindorm_standalone: single-node Lindorm instance lts: Lindorm Tunnel Service (LTS) instance
QueryStr	String	No	Yes	The keyword of the instance names, which is used to perform fuzzy searches for instances.	None.
InstanceIds	List	No	Yes	The IDs of the instances.	You can specify up to 20 instance IDs.
SupportEngine	Integer	No	Yes	The engine types that are supported by the instances.	Valid values: 1: LindormSearch 2: LindormTSDB 4: LindormTable 8: LindormDFS Note For example, if you set SupportEngine to 15, which is the sum of 8, 4, 2, and 1, the instance supports the LindormSearch, LindormTSDB, LindormTable, and LindormDFS engines. If you set SupportEngine to 6, which is the sum of 4 and 2, the instance supports the LindormTSDB and LindormTable engines.
Tags	List	No	Yes	The tags.	You can add up to five tags.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property	Type	Required	Editable	Description	Constraint
Value	String	No	No	The tag value.	None.
Key	String	Yes	No	The tag key.	None.

Return values

Fn::GetAtt

Instances: details of the instances.
InstanceIds: the IDs of the instances.

Property	Type	Description	Constraint
InstanceIds	List	The IDs of the instances.	None.
Instances	List	Details of the instances.	None.
EnableBlob	Boolean	Indicates whether Binary Large Object (BLOB) is enabled for the instance.	Valid values: true false
CreateTime	String	The time when the instance was created.	None.
ResourceGroupId	String	The ID of the resource group.	None.
EnableShs	Boolean	Indicates whether the history server of Lindorm Distributed Processing System (LDPS) is enabled.	Valid values: true false
VpcId	String	The ID of the virtual private cloud (VPC) in which the instance resides.	None.
MaintainStartTime	String	The start time of the maintenance window.	None.
ServiceType	String	The category of the instance.	None.
EnableML	String	Indicates whether machine learning (ML) is enabled.	None.
EnableBDS	String	Indicates whether LTS is enabled.	None.
CoreNum	String	The number of the core nodes. This property is returned only for multi-zone instances.	None.
EngineType	String	The supported engine type.	None.
DiskThreshold	String	The threshold of the disk capacity.	None.
EnableSSL	Boolean	Indicates whether SSL encryption is enabled.	Valid values: true false
MaintainEndTime	String	The end time of the maintenance window.	None.
LogNum	Integer	The number of the log nodes. This property is returned only for multi-zone instances.	None.
DiskCategory	String	The storage type.	None.
EnablePhoenix	String	Indicates whether Phoenix is enabled.	None.
EnableLTS	String	Indicates whether the LTS engine is enabled for the instance.	None.
LocalCloudStorage	String	The cloud storage service that is set up in an on-premises environment.	None.
VswitchId	String	The vSwitch ID.	None.
EnableLsqlVersionV3	String	Indicates whether LsqlVersionV3 is enabled.	None.
ColdStorage	String	The Capacity storage size.	None.
CoreSingleStorage	Integer	The disk capacity of a core node. This property is returned only for multi-zone instances.	None.
InstanceStorage	String	The storage size of the instance.	None.
EngineList	List	The information about the engines.	None.
ExpiredMilliseconds	String	The expiration time of the instance. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	None.
EnableKms	Boolean	Indicates whether Key Management Service (KMS) is enabled.	None.
NetworkType	String	The network type of the instance.	None.
CreateMilliseconds	Integer	The time when the instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	None.
PayType	String	The billing method of the instance.	None.
DeletionProtection	String	Indicates whether deletion protection is enabled.	None.
EnableCdc	String	Indicates whether data subscription is enabled for the instance.	None.
InstanceId	String	The instance ID.	None.
InstanceStatus	String	The status of the instance.	None.
EnableCompute	Boolean	Indicates whether LDPS is enabled for the instance.	Valid values: true false
DiskUsage	String	The disk usage.	None.
InstanceAlias	String	The instance name.	None.
EnableMLCtrl	String	Indicates whether AI control nodes are enabled.	None.
LocalCloudCategory	String	The category of the cloud storage service that is set up in an on-premises environment.	None.
LogSingleStorage	Integer	The disk capacity of a log node. This property is returned only for multi-zone instances.	None.
ArchVersion	String	The deployment architecture.	None.
EnableStream	String	Indicates whether the streaming engine is enabled for the instance.	None.
ZoneId	String	The zone ID.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  QueryStr:
    Type: String
    Description: Instance name keyword, which can be used for fuzzy search.
    Default: test
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::Lindorm::Instances
    Properties:
      QueryStr:
        Ref: QueryStr
Outputs:
  Instances:
    Description: The detail list of The instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Instances
  InstanceIds:
    Description: The list of The instance list.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "QueryStr": {
      "Type": "String",
      "Description": "Instance name keyword, which can be used for fuzzy search.",
      "Default": "test"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::Lindorm::Instances",
      "Properties": {
        "QueryStr": {
          "Ref": "QueryStr"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The detail list of The instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of The instance list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}