DocsICP FilingConsole
Documentation

DATASOURCE::Lindorm::Instances

Updated at:
Copy as MD
Product
My Favorites

DATASOURCE::Lindorm::Instances类型用于查询Lindorm实例信息。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

ResourceGroupId

String

否

是

资源组ID。

无

ServiceType

String

否

是

实例类型。

取值：

  • lindorm：表示Lindorm单可用区实例。

  • lindorm_multizone：表示Lindorm多可用区实例。

  • serverless_lindorm：表示Lindorm Serverless实例。

  • lindorm_standalone：表示Lindorm单节点实例。

  • lts：表示Lindorm数据通道服务类型。

QueryStr

String

否

是

实例名称关键字，可用于模糊搜索。 

无

InstanceIds

List

否

是

实例ID。

最多支持20个实例。

SupportEngine

Integer

否

是

查询的实例支持的数据引擎类型。

取值：

  • 1：支持搜索引擎。

  • 2：支持时序引擎。

  • 4：支持宽表引擎。

  • 8：支持文件引擎。

说明

例如：SupportEngine取值为15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。SupportEngine取值为6，6=4+2，表示该实例支持时序引擎和宽表引擎。

Tags

List

否

是

标签列表。

最多支持5个标签。

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

  • Never（默认值）：更新堆栈时，从不刷新数据源资源。

  • Always：更新堆栈时，始终刷新数据源资源。

Tags语法

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

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Value

String

否

否

标签的值。

无

Key

String

是

否

标签的键。

无

返回值

Fn::GetAtt

  • Instances：Lindorm实例信息列表。

  • InstanceIds：Lindorm实例ID列表。

属性名称

类型

描述

约束

InstanceIds

List

Lindorm实例ID列表。

无

Instances

List

Lindorm实例信息列表。

无

EnableBlob

Boolean

实例是否开通LBlob。

取值：

  • true：开通LBlob。

  • false：不开通LBlob。

CreateTime

String

实例的创建时间。

无

ResourceGroupId

String

资源组ID。

无

EnableShs

Boolean

是否开通计算引擎History Server。

取值：

  • true：开通计算引擎History Server。

  • false：不开通计算引擎History Server。

VpcId

String

实例所属的专有网络ID。

无

MaintainStartTime

String

可维护开始时间。

无

ServiceType

String

实例类型。

无

EnableML

String

是否开启ML。

无

EnableBDS

String

是否开启BDS。

无

CoreNum

String

多可用区实例，core节点数量。

无

EngineType

String

支持引擎的类型。

无

DiskThreshold

String

磁盘空间的阈值。

无

EnableSSL

Boolean

是否开启SSL链路加密功能。

取值：

  • true：开启SSL链路加密功能。

  • false：开启SSL链路加密功能。

MaintainEndTime

String

可维护结束时间。

无

LogNum

Integer

多可用区实例，log节点数量。

无

DiskCategory

String

存储类型。

无

EnablePhoenix

String

是否开通Phoenix。

无

EnableLTS

String

实例是否开通LTS引擎。

无

LocalCloudStorage

String

本地云存储。

无

VswitchId

String

虚拟交换机ID。

无

EnableLsqlVersionV3

String

是否开通LsqlVersionV3。

无

ColdStorage

String

容量型云存储容量。

无

CoreSingleStorage

Integer

多可用区实例，core单节点磁盘容量。

无

InstanceStorage

String

实例的存储容量。

无

EngineList

List

引擎信息列表。

无

ExpiredMilliseconds

String

实例到期时间与1970-01-01 00:00:00之间的毫秒值。

无

EnableKms

Boolean

是否开启密钥管理服务KMS。

无

NetworkType

String

实例的网络类型。

无

CreateMilliseconds

Integer

表示实例创建时间与1970-01-01 00:00:00之间的毫秒值。

无

PayType

String

实例的付费类型。

无

DeletionProtection

String

是否开启删除保护。

无

EnableCdc

String

是否开通实例的数据订阅功能。

无

InstanceId

String

实例ID。

无

InstanceStatus

String

实例状态。

无

EnableCompute

Boolean

是否开通实例的计算引擎。

取值：

  • true：开通实例的计算引擎。

  • false：开通实例的计算引擎。

DiskUsage

String

磁盘空间使用率。

无

InstanceAlias

String

实例名称。

无

EnableMLCtrl

String

是否开通AI控制节点。

无

LocalCloudCategory

String

本地云类别。

无

LogSingleStorage

Integer

多可用区实例，log单节点磁盘容量。

无

ArchVersion

String

部署架构。

无

EnableStream

String

实例是否开通流引擎。

无

ZoneId

String

可用区ID。

无

示例

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

{
  "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"
        ]
      }
    }
  }
}
Previous：DATASOURCE::KMS::SecretsNext：ALIYUN::Lindorm::Instance